Update Contact (early access)

PATCH /unified/crm/contacts/{id}

Try it

Update Contact (early access)

cURL

curl --request PATCH \
  --url https://api.stackone.com/unified/crm/contacts/{id} \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --header 'x-account-id: <x-account-id>' \
  --data '
{
  "first_name": "Steve",
  "last_name": "Wozniak",
  "company_name": "Apple Inc.",
  "emails": [
    "[e-mail]"
  ],
  "phone_numbers": [
    "123-456-7890"
  ],
  "deal_ids": [
    "deal-001",
    "deal-002"
  ],
  "account_ids": [
    "account-123",
    "account-456"
  ],
  "custom_fields": [
    {
      "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
      "name": "Training Completion Status",
      "value": "Completed",
      "value_id": "value_456",
      "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
    }
  ],
  "passthrough": {
    "other_known_names": "John Doe"
  }
}
'

200

{
  "data": {
    "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
    "unified_custom_fields": {
      "my_project_custom_field_1": "REF-1236",
      "my_project_custom_field_2": "some other value"
    },
    "first_name": "Steve",
    "last_name": "Wozniak",
    "company_name": "Apple Inc.",
    "emails": [
      "[e-mail]"
    ],
    "phone_numbers": [
      "123-456-7890"
    ],
    "deal_ids": [
      "deal-001",
      "deal-002"
    ],
    "remote_deal_ids": [
      "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
    ],
    "account_ids": [
      "account-123",
      "account-456"
    ],
    "remote_account_ids": [
      "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
      "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
    ],
    "custom_fields": [
      {
        "id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "remote_id": "8187e5da-dc77-475e-9949-af0f1fa4e4e3",
        "name": "Training Completion Status",
        "value": "Completed",
        "value_id": "value_456",
        "remote_value_id": "e3cb75bf-aa84-466e-a6c1-b8322b257a48"
      }
    ],
    "created_at": "2021-01-01T01:01:01.000Z",
    "updated_at": "2021-01-01T01:01:01.000Z"
  },
  "raw": [
    {
      "method": "<string>",
      "url": "<string>",
      "body": {},
      "response": {}
    }
  ]
}

Authorizations

Authorization · string · header · required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Headers

x-account-id · string · required

The account identifier

Path Parameters

id · string · required

Body

application/json

first_name · string | null

The contact first name

Example:

"Steve"

last_name · string | null

The contact last name

Example:

"Wozniak"

company_name · string | null

The contact company name

Example:

"Apple Inc."

emails · string[] | null

List of contact email addresses

Example:

["[e-mail]"]

phone_numbers · string[] | null

List of contact phone numbers

Example:

["123-456-7890"]

deal_ids · string[] | null

List of associated deal IDs

Example:

["deal-001", "deal-002"]

account_ids · string[] | null

List of associated account IDs

Example:

["account-123", "account-456"]

custom_fields · object[] | null

Contact custom fields

Show child attributes

custom_fields. id · string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

custom_fields. remote_id · string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

custom_fields. name · string | null

The name of the custom field.

Example:

"Training Completion Status"

custom_fields. value

The value associated with the custom field.

Example:

"Completed"

custom_fields. value_id · string | null

The unique identifier for the value of the custom field.

Example:

"value_456"

custom_fields. remote_value_id · string | null

Provider's unique identifier for the value of the custom field.

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

passthrough · object

Value to pass through to the provider

Example:

{ "other_known_names": "John Doe" }

Response

200

application/json

The contact was successfully updated.

data · object · required

Show child attributes

data. id · string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data. remote_id · string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data. unified_custom_fields · object

Custom Unified Fields configured in your StackOne project

Example:

{
  "my_project_custom_field_1": "REF-1236",
  "my_project_custom_field_2": "some other value"
}

data. first_name · string | null

The contact first name

Example:

"Steve"

data. last_name · string | null

The contact last name

Example:

"Wozniak"

data. company_name · string | null

The contact company name

Example:

"Apple Inc."

data. emails · string[] | null

List of contact email addresses

Example:

["[e-mail]"]

data. phone_numbers · string[] | null

List of contact phone numbers

Example:

["123-456-7890"]

data. deal_ids · string[] | null

List of associated deal IDs

Example:

["deal-001", "deal-002"]

data. remote_deal_ids · string[] | null

Provider's list of associated deal IDs

Example:

[
  "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
  "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
]

data. account_ids · string[] | null

List of associated account IDs

Example:

["account-123", "account-456"]

data. remote_account_ids · string[] | null

Provider's list of associated account IDs

Example:

[
  "e3cb75bf-aa84-466e-a6c1-b8322b257a48",
  "e3cb75bf-aa84-466e-a6c1-b8322b257a49"
]

data. custom_fields · object[] | null

Contact custom fields

Show child attributes

data.custom_fields. id · string | null

Unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.custom_fields. remote_id · string | null

Provider's unique identifier

Example:

"8187e5da-dc77-475e-9949-af0f1fa4e4e3"

data.custom_fields. name · string | null

The name of the custom field.

Example:

"Training Completion Status"

data.custom_fields. value

The value associated with the custom field.

Example:

"Completed"

data.custom_fields. value_id · string | null

The unique identifier for the value of the custom field.

Example:

"value_456"

data.custom_fields. remote_value_id · string | null

Provider's unique identifier for the value of the custom field.

Example:

"e3cb75bf-aa84-466e-a6c1-b8322b257a48"

data. created_at · string<date-time> | null

Timestamp when the contact was created

Example:

"2021-01-01T01:01:01.000Z"

data. updated_at · string<date-time> | null

Timestamp when the contact was last updated

Example:

"2021-01-01T01:01:01.000Z"

raw · object[] | null

Show child attributes

raw. method · string · required

raw. url · string · required

raw. body · object

raw. response