Job Contacts

Update a Job Contact

Changed on

OAuth Scope

This endpoint requires the following OAuth scope manage_job_contacts.

post/jobcontact/{uuid}.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/jobcontact/{uuid}.json
  • Auth
    • API key in header X-Api-Key
    • or OAuth 2
      Authorization code: https://api.servicem8.com/oauth/authorize
      Token URL: https://api.servicem8.com/oauth/access_token scopes: manage_job_contacts

Path parameters

uuidstring uuid required

UUID of the Job Contact

Request body

job_uuidstring uuid

UUID of the job this contact is associated with. Each job contact must be linked to a valid job in the system. This field cannot be changed once set.

firststring

First name of the job contact. This information is synced with the job's contact information fields depending on the contact type.

laststring

Last name of the job contact. This information is synced with the job's contact information fields depending on the contact type.

phonestring

Landline or office phone number of the job contact. Format is flexible but should represent a valid phone number. This field syncs with the job's phone_1 field for job contacts or phone_2 field for billing contacts.

mobilestring

Mobile phone number of the job contact. Format is flexible but should represent a valid mobile number. This field syncs with the job's mobile field for job contacts or billing_mobile field for billing contacts.

emailstring email

Email address of the job contact. Should be a valid email format. Used for sending job-related communications. This field syncs with the job's email field for job contacts or billing_email field for billing contacts.

typestring

Type of contact relationship to the job. Valid values are: 'JOB' (or 'Job Contact'), 'BILLING' (or 'Billing Contact'), or 'Property Manager'. Controls which job fields are updated when this contact record changes.

is_primary_contactunknown
uuidstring uuid

Unique identifier for this record

Example request

{
  "job_uuid": "123e4567-65f9-48f6-b5d5-23f946e3196b",
  "uuid": "123e4567-2b6e-4cc4-aa5d-23f9486bcefb"
}

Response

Success - The record was updated successfully

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes

  • 638a8df09bf4Revision changes
    • breaking

      the request property type changed from string to no type

    • warning

      removed the request property

  • ca9b053c4373Revision changes
    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status