SEservicem8
Company Contacts

Update a Company Contact

Changed on

OAuth Scope

This endpoint requires the following OAuth scope manage_customer_contacts.

post/companycontact/{uuid}.json

Request

  • Base URL
    https://api.servicem8.com/api_1.0
  • URL
    https://api.servicem8.com/api_1.0/companycontact/{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_customer_contacts

Path parameters

uuidstring uuid required

UUID of the Company Contact

Request body

company_uuidstring uuid

The UUID of the company this contact belongs to

firststring

First name of the company contact. Used for identifying and addressing the contact in communications.

laststring

Last name of the company contact. Used together with the first name to identify the contact.

phonestring

Primary phone number for the contact. Used for voice communications with the contact. Should include area code and can include international code.

mobilestring

Mobile phone number for the contact. Used for SMS communications and alternative voice contact. Should include area code and can include international code.

emailstring email

Email address of the contact. Used for sending email communications, quotes, invoices, and other electronic correspondence.

typestring

Specifies the type of contact. Common values include 'BILLING' for billing contacts and 'JOB' for job contacts. This field determines how the contact is used in the system.

is_primary_contactstring

Indicates whether this contact is the primary contact for the company. Value of 1 means this is the primary contact, 0 means it is not. A company should have only one active primary contact.

uuidstring uuid

Unique identifier for this record

Example request

{
  "company_uuid": "123e4567-02d4-4ed9-a25b-23f9484d2f2b",
  "uuid": "123e4567-5fd5-4f90-b189-23f943d02b9b"
}

Response

Success - The record was updated successfully

errorCodenumber
messagestring

Example response

{
  "message": "OK"
}

Changes

  • 638a8df09bf4Revision changes
    • 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