Update a Contact

Description

This endpoint is used to update a contact. The studioId field is used to associate the contact with a specific studio, which can be obtained from the Get Studios endpoint.

Endpoint

/v1/contacts/{entityId}

Request parameters

{
  "firstName": "Minnie",
  "studioId": "e806110e-1ffe-4cbf-a6ef-fbccd18740fd"
}

Responses

{
  "message": "The update to 62f54317-ed6b-495e-bae9-1aba0eda8786 should not deleted the current email.",
  "errorCode": "BAD_REQUEST",
  "errors": [
    {
      "path": "/v1/contacts/62f54317-ed6b-495e-bae9-1aba0eda8786",
      "message": "The update to 62f54317-ed6b-495e-bae9-1aba0eda8786 should not deleted the current email.",
      "errorCode": "BAD_REQUEST"
    }
  ]
}

{
  "message": "The contact Minnie Mouse with email minnie.mouse@disney.com already exists for the studio 83361967-44bc-426e-ac21-080e585440f3",
  "errorCode": "E016",
  "errors": [
    {
      "path": "/v1/contacts/ac17c413-ae48-448d-b48b-9e660fd61df6",
      "message": "The contact Minnie Mouse with email minnie.mouse@disney.com already exists for the studio 83361967-44bc-426e-ac21-080e585440f3",
      "errorCode": "E016"
    }
  ],
  "meta": {
    "entityId": "408e0333-3c28-4ade-913d-b3952ac281a7"
  }
}

{
  "message": {
    "message": "Invalid email format: minnie.mousedisney.com",
    "errorCode": "UNPROCESSABLE_ENTITY",
    "errors": [
      {
        "path": "/v1/contacts/ac17c413-ae48-448d-b48b-9e660fd61df6",
        "message": "Invalid email format: minnie.mousedisney.com",
        "errorCode": "UNPROCESSABLE_ENTITY"
      }
    ]
  }
}

Examples

The following table shows a sample of how to update various fields on a contact. You can update one or more fields in a single request.

Let's start with the assumption our contact has no email and looks like the following:

{
  "firstName": "Minnie",
  "lastName": "Mouse",
  "studioId": "e806110e-1ffe-4cbf-a6ef-fbccd18740fd"
}

If there were an email set on this contact, then it'd have to be part of the request.

Description	Example Body
Add Email	`{"firstName": "Minnie", "lastName": "Mouse", "email": "minnie.mouse@disney.com", "studioId": "e806110e-1ffe-4cbf-a6ef-fbccd18740fd"}`
Add Parent Contact ID	`{"firstName": "Minnie", "lastName": "Mouse", "parentContactId": "bdb47844-61ce-4e7b-986c-9f54e2f58cef", studioId": "e806110e-1ffe-4cbf-a6ef-fbccd18740fd"}`
Add Translated Legal Name	`{"firstName": "Minnie", "lastName": "Mouse", "translatedLegalName": "Minnie Mouse", studioId": "e806110e-1ffe-4cbf-a6ef-fbccd18740fd"}`
Update First Name and Keep Last Name	`{"firstName": "Mickey", "lastName": "Mouse", "studioId": "e806110e-1ffe-4cbf-a6ef-fbccd18740fd"}`
Update First Name and Remove Last Name	`{"firstName": "Mickey", "studioId": "e806110e-1ffe-4cbf-a6ef-fbccd18740fd"}`
Update Studio ID	`{"firstName": "Minnie", "lastName": "Mouse", studioId": "bd79aecb-31cc-45fe-872e-79978d7ef26f"}`

Create Contact: Create a new contact.
Search Contacts: Look up existing contacts before creating a new one.
Get Studios: Retrieve valid studio IDs for creating contacts.
Create Contract: Use a contact as talent in a contract.
API Reference: See all available endpoints and details.