Attributes

This page provides API documentation for performing operations on Dynamic Attributes.

Partially update (merge) dynamic attributes for an entity

patch

Access Control:

• Allowed Roles: MEMBER

• Impersonated User Allowed: No

• Organization API Key Allowed: Yes

Patch Behavior:

• Attribute not present in request: A new attribute will be created.

• Attribute set to null: The request will fail because the attribute has a non-null validation constraint.

• Attribute set to an empty object ({ }): No changes will be applied.

Authorizations

bearer-keyx-org-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

entityTypestringRequired

entityIdstringRequired

Entity ID. For entity type 'lead', accepts either the Saleschat-generated lead ID (UUID) or the lead's CRM ID. For other entity types, the exact entity ID is required.

Body

application/json

Responses

200

Successfully patched attributes

application/json

idinteger · int64Optional

org_idstringOptional

entity_typestringOptional

entity_idstringOptional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

400

Invalid request data

application/json

401

Unauthorized - Authentication is required

application/json

403

Unauthorized access

application/json

422

Unknown entity type

application/json

500

Internal Server Error - Something went wrong on the server

application/json

patch/v4/orgs/{orgId}/dynamic-attributes/{entityType}/{entityId}

HTTPcURLJavaScriptPython

PATCH /v4/orgs/{orgId}/dynamic-attributes/{entityType}/{entityId} HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": 1,
  "org_id": "text",
  "entity_type": "text",
  "entity_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "created_at": "2026-07-12T16:52:19.499Z",
  "updated_at": "2026-07-12T16:52:19.499Z"
}

Deprecated

Partially update (merge) dynamic attributes for an entity

patch

Access Control:

• Allowed Roles: MEMBER

• Impersonated User Allowed: No

• Organization API Key Allowed: Yes

Patch Behavior:

• Attribute not present in request: A new attribute will be created.

• Attribute set to null: The request will fail because the attribute has a non-null validation constraint.

• Attribute set to an empty object ({ }): No changes will be applied.

Authorizations

bearer-keyx-org-api-key

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

orgIdstringRequired

entityTypestringRequired

entityIdstringRequired

Body

application/json

Responses

200

Successfully patched attributes

application/json

idinteger · int64Optional

org_idstringOptional

entity_typestringOptional

entity_idstringOptional

created_atstring · date-timeOptional

updated_atstring · date-timeOptional

400

Invalid request data

application/json

401

Unauthorized - Authentication is required

application/json

403

Unauthorized access

application/json

500

Internal Server Error - Something went wrong on the server

application/json

patch/v1/orgs/{orgId}/dynamic-attributes/{entityType}/{entityId}

HTTPcURLJavaScriptPython

PATCH /v1/orgs/{orgId}/dynamic-attributes/{entityType}/{entityId} HTTP/1.1
Host: apis.saleschat.pro
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 45

{
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  }
}

{
  "id": 1,
  "org_id": "text",
  "entity_type": "text",
  "entity_id": "text",
  "attributes": {
    "ANY_ADDITIONAL_PROPERTY": {}
  },
  "created_at": "2026-07-12T16:52:19.499Z",
  "updated_at": "2026-07-12T16:52:19.499Z"
}