PATCH
/
v1
/
contacts
/
{id}
curl --request PATCH \
  --url https://dev-public-api.openphone.dev/v1/contacts/{id} \
  --header 'Content-Type: application/json' \
  --data '{
  "defaultFields": {
    "firstName": "John",
    "lastName": "Doe",
    "company": "OpenPhone",
    "role": "Sales",
    "emails": [
      {
        "name": "company email",
        "value": "info@openphone.com",
        "id": "acb123"
      }
    ],
    "phoneNumbers": [
      {
        "name": "company phone",
        "value": "+15555555555",
        "id": "acb123"
      }
    ]
  },
  "customFields": [
    {
      "key": "inbound-lead",
      "id": "66d0d87d534de8fd1c433cec3",
      "value": [
        "option1",
        "option2"
      ]
    }
  ]
}'
{
  "data": {
    "id": "664d0db69fcac7cf2e6ec",
    "source": "public-api",
    "defaultFields": {
      "firstName": "John",
      "lastName": "Doe",
      "company": "OpenPhone",
      "role": "Sales",
      "emails": [
        {
          "name": "company email",
          "value": "abc@example.com",
          "id": "acb123"
        }
      ],
      "phoneNumbers": [
        {
          "name": "company phone",
          "value": "+12345678901",
          "id": "acb123"
        }
      ]
    },
    "customFields": [
      {
        "name": "Inbound Lead",
        "key": "inbound-lead",
        "type": "multi-select",
        "value": [
          "option1",
          "option2"
        ]
      }
    ],
    "createdAt": "2022-01-01T00:00:00Z",
    "updatedAt": "2022-01-01T00:00:00Z",
    "createdByUserId": "US123abc"
  }
}

Path Parameters

id
string
required

The unique identifier of the contact.

Examples:

"66d0d87e8dc1211467372303"

Body

application/json

Response

200
application/json

Success

The response is of type object.