v1

latestOpenAPI 3.0.02026-07-26870415.2 KB

custom_attributes

Patch custom attributes for a contact

Upserts one or more custom attribute values for a contact. Requires a token with write access.

patch/v1/contacts/{id}/custom-attributes

Path parameters

idstring required

Contact id.

Example:ph77c0dy0mgdpzmqz6tesry8w184002s

Query parameters

workspace_idstring

Optional workspace override. If omitted, Conduit resolves the contact's workspace automatically.

Example:j57demo8f8x7c9v0n2q4r6t8y1u3i5o

Request body

Example request

{
  "attributes": [
    {
      "id": "attr_123",
      "value": "vip"
    },
    {
      "id": "attr_456",
      "value": null
    }
  ]
}

Response

Updated contact custom attributes

Example response

{
  "data": [
    {
      "id": "attr_123",
      "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
      "name": "VIP Status",
      "type": "Select",
      "options": [
        {
          "value": "standard",
          "color": "gray"
        },
        {
          "value": "vip",
          "color": "green"
        }
      ],
      "order": 1,
      "section_id": "section_123",
      "section_name": "Contact Info",
      "value": "vip"
    },
    {
      "id": "attr_456",
      "workspace_id": "j57demo8f8x7c9v0n2q4r6t8y1u3i5o",
      "name": "Move-in Date",
      "type": "Date",
      "options": null,
      "order": 2,
      "section_id": "section_123",
      "section_name": "Contact Info",
      "value": null
    }
  ]
}