BackOffice ERPInstall

Summary

Create a new contact associated with a specified customer in BackOffice ERP by providing required details such as customer identifier, first name, last name, and email, along with optional fields like title, phone number, and various email notification settings.

Inputs

• customer_id (required) — Identifier of the customer to whom the contact will be linked; supports smart search by name, email, or keyword instead of numeric ID.
• firstname (required) — Contact's first name.
• lastname (required) — Contact's last name.
• email (required) — Contact's email address.
• title — Contact's position or job title.
• phonenumber — Contact's phone number.
• [direction — Optional text direction attribute (e.g., 'rtl' or 'ltr').
• password — Password required only if sending a set password email.
• [is_primary — Optional flag to mark contact as primary (set to 'on').
• donotsendwelcomeemail — Optional flag to prevent sending the welcome email (set to 'on').
• send_set_password_email — Optional flag to send an email for setting the password (set to 'on').
• permissions — Optional permissions array string for the contact.
• [invoice_emails — Optional flag for invoice email notifications (set value same as name).
• [estimate_emails — Optional flag for estimate email notifications (set value same as name).
• [credit_note_emails — Optional flag for credit note email notifications (set value same as name).
• [project_emails — Optional flag for project email notifications (set value same as name).
• [ticket_emails — Optional flag for ticket email notifications (set value same as name).
• [task_emails — Optional flag for task email notifications (set value same as name).
• [contract_emails — Optional flag for contract email notifications (set value same as name).

Output shape

a JSON object containing the created contact details or an error message; in cases of ambiguous customer identification, returns multiple matches requiring disambiguation.

Supports smart search for customer identification by non-numeric identifiers. Returns detailed feedback via output for smart search results, including multiple matches. Throws errors if required fields are missing or if numeric ID cannot be resolved. Optional fields control welcome and password emails and email notification preferences.

Examples

Example 1: Create a contact for a customer using customer name 'ACME Corp' instead of its numeric ID, with mandatory fields.

Provide 'customer_id' set to 'ACME Corp', 'firstname', 'lastname', and 'email'. Other fields optional.