Update CRM Config

Update the organization’s CRM configuration. Omitted fields stay as they are; a field that is sent replaces its stored value in full.

POST /update-crm-config

JavaScript

JavaScript

import Retell from 'retell-sdk';

const client = new Retell({
  apiKey: process.env['RETELL_API_KEY'], // This is the default and can be omitted
});

const crmConfig = await client.crm.updateConfig();

console.log(crmConfig.org_id);

200

{
  "org_id": "<string>",
  "app_id": "<string>",
  "last_sync_timestamp": 123,
  "custom_fields": [
    {
      "name": "<string>",
      "type": "string",
      "label": "<string>",
      "description": "<string>",
      "options": [
        "<string>"
      ]
    }
  ],
  "crm_analysis_data_mappings": [
    {
      "field_name": "<string>",
      "analysis_data_name": "<string>",
      "update_mode": "overwrite"
    }
  ],
  "contact_columns_order": [
    "<string>"
  ],
  "contact_tags": [
    "<string>"
  ]
}

Authorizations

Authorization · string · header · required

Authentication header containing API key (find it in dashboard). The format is "Bearer YOUR_API_KEY"

Body

application/json

app_id · string | null

ID of the CRM app to link. Pass null to unlink, which stops syncing. Changing it resets the sync cursor, so the next sync re-reads every contact from the new CRM.

custom_fields · object[]

Replaces the stored list. Names must be snake_case and cannot collide with a built-in contact field or start with contact/external. Removing a field that an analysis data mapping still targets is rejected — send crm_analysis_data_mappings in the same request to retarget or drop those mappings.

Maximum array length: 200

Show child attributes

crm_analysis_data_mappings · object[]

Replaces the stored list.

Maximum array length: 200

Show child attributes

contact_tags · string[] | null

Replaces the organization's available contact tags. Tags are trimmed and deduplicated. Omit to leave unchanged, or send null or an empty array to clear the list. Does not change tags already assigned to contacts.

Maximum array length: 1000

Required string length: 1 - 40

Pattern: \S

contact_columns_order · string[]

Preferred display order of contact fields, for clients that render contacts as a table. Not used by the API itself.

Maximum array length: 200

Response

200

application/json

Updated CRM config.

org_id · string · required

app_id · string

The connected CRM integration app ID.

last_sync_timestamp · number

Epoch milliseconds of the last successful sync.

custom_fields · object[]

Show child attributes

crm_analysis_data_mappings · object[]

Show child attributes

contact_columns_order · string[]

Preferred display order of contact fields, for clients that render contacts as a table. Not used by the API itself.

contact_tags · string[]

Tags available to contacts in this organization.

Maximum array length: 1000

Required string length: 1 - 40

Pattern: \S