Create Customer Contact

View as Markdown

Headers

{{tenant_key_name}}stringOptional

Request

This endpoint expects a multipart form.
faxstringRequired

Optional: Fax number

emailstringRequired

Optional: Email address

notesstringRequired

Optional: Additional notes about this contact

titlestringRequired

Optional: Title (Mr., Ms., Dr., etc.)

job_titlestringRequired

Optional: Job title

last_namestringRequired

Required: Last name

departmentstringRequired

Optional: Department

first_namestringRequired

Required: First name

is_primarystringRequired

Optional: Set as primary contact (true, false)

phone_workstringRequired

Optional: Work phone number

accepts_smsstringRequired

Optional: Accepts SMS messages (true, false)

company_namestringRequired

Optional: Company name

contact_typestringRequired

Required: Contact type (primary, billing, emergency, technical, administrative, other)

phone_mobilestringRequired

Optional: Mobile phone number

contact_sincestringRequired

Optional: Contact relationship start date (YYYY-MM-DD)

phone_primarystringRequired

Optional: Primary phone number

available_24_7stringRequired

Optional: Available 24/7 for emergencies (true, false)

phone_extensionstringRequired

Optional: Phone extension

accepts_marketingstringRequired

Optional: Accepts marketing communications (true, false)

can_make_paymentsstringRequired

Optional: Can make payments (true, false)

can_view_invoicesstringRequired

Optional: Can view invoices (true, false)

receives_invoicesstringRequired

Optional: Receives invoices (true, false)

can_approve_quotesstringRequired

Optional: Can approve quotes (true, false)

can_authorize_workstringRequired

Optional: Can authorize work orders (true, false)

emergency_prioritystringRequired

Optional: Emergency priority level (1-10, required if is_emergency_contact is true)

preferred_languagestringRequired

Optional: Preferred language code

authorization_limitstringRequired

Optional: Work authorization limit in dollars (required if can_authorize_work is true)

relationship_statusstringRequired

Optional: Relationship status (active, inactive, suspended, do_not_contact)

can_schedule_servicestringRequired

Optional: Can schedule service appointments (true, false)

customer_location_idstringRequired

Optional: Associated location ID

is_emergency_contactstringRequired

Optional: Is emergency contact (true, false)

portal_access_enabledstringRequired

Optional: Enable portal access (true, false)

preferred_contact_timestringRequired

Optional: Preferred contact time (morning, afternoon, evening, business_hours, anytime)

preferred_contact_methodstringRequired

Optional: Preferred contact method (phone, email, sms, portal, mail)

receives_emergency_alertsstringRequired

Optional: Receives emergency alerts (true, false)

receives_service_remindersstringRequired

Optional: Receives service reminders (true, false)

accepts_email_notificationsstringRequired

Optional: Accepts email notifications (true, false)

receives_completion_noticesstringRequired

Optional: Receives completion notices (true, false)

portal_password_reset_requiredstringRequired

Optional: Require password reset on first login (true, false)

receives_appointment_confirmationsstringRequired

Optional: Receives appointment confirmations (true, false)

Errors

404
Not Found Error
422
Unprocessable Entity Error