POST/api/custom-fields

Creates a custom field definition for conversations or visitors in the authenticated organization. Field names are immutable API keys. Select fields require localized options, and labels, placeholders, and validation messages are stored as localized lifecycle content.

Endpoint requirements

Credentials: Use either Bearer API key or X-API-Key header.
Required scope: custom-fields:write
Module: Automation & API module (automation_api)
Organization and site scope: Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
Retry behavior: Convergent write: Retrying leaves the resource in the same resulting state. If the first request succeeded, a later retry may return conflict or not found because the change has already taken effect.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body accepted by this operation.

Response Body

`application/json`

{
  "id": "42880ce7-4d1d-469d-a63e-fd75f2c3e96e",
  "orgId": "8ea0b557-d794-41ce-b86e-44f4780da2b5",
  "name": "account_tier",
  "type": "select",
  "required": false,
  "target": "conversation",
  "sortOrder": 10,
  "active": true,
  "label": "Account tier",
  "placeholder": "Choose a tier",
  "validationMessage": null,
  "locale": "en",
  "fallbackUsed": false,
  "options": [
    {
      "id": "d879cc4e-11ce-46f3-be45-47d20de0a48f",
      "value": "enterprise",
      "sortOrder": 0,
      "label": "Enterprise",
      "locale": "en",
      "fallbackUsed": false,
      "translations": [
        {
          "id": "fc094ad3-b971-438f-9884-ae47e3581e4c",
          "locale": "en",
          "status": "published",
          "sourceLocale": null,
          "machineTranslatedAt": null,
          "reviewedAt": null,
          "reviewedBy": null,
          "createdAt": "2026-08-03T18:00:00.000Z",
          "updatedAt": "2026-08-03T18:00:00.000Z",
          "label": "Enterprise"
        }
      ],
      "createdAt": "2026-08-04T10:00:00.000Z",
      "updatedAt": "2026-08-04T10:00:00.000Z"
    }
  ],
  "translations": [
    {
      "id": "3ff47837-a302-466b-925d-6b53d0bbfb37",
      "locale": "en",
      "status": "published",
      "sourceLocale": null,
      "machineTranslatedAt": null,
      "reviewedAt": null,
      "reviewedBy": null,
      "createdAt": "2026-08-03T18:00:00.000Z",
      "updatedAt": "2026-08-03T18:00:00.000Z",
      "label": "Account tier",
      "placeholder": "Choose a tier",
      "validationMessage": null
    }
  ],
  "createdAt": "2026-08-03T18:00:00.000Z",
  "updatedAt": "2026-08-03T18:00:00.000Z"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required.",
    "correlationId": "req_01K0MANAGEMENT401"
  }
}

{
  "error": {
    "code": "INTEGRATION_MODULE_REQUIRED",
    "message": "The automation API module is required.",
    "details": {
      "module": "automation_api",
      "feature": "public_api"
    },
    "correlationId": "req_01K0MANAGEMENT402"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "The caller lacks the required role or API-key scope.",
    "correlationId": "req_01K0MANAGEMENT403"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "CONFLICT",
    "message": "The requested change conflicts with current resource state.",
    "correlationId": "req_01K0MANAGEMENT409"
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request payload is invalid.",
    "details": {
      "field": "name"
    },
    "correlationId": "req_01K0MANAGEMENT422"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests.",
    "correlationId": "req_01K0MANAGEMENT429"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Request examples

curl

curl --request POST \
  'https://api.convor.io/api/custom-fields' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "account_tier",
  "type": "select",
  "required": false,
  "target": "conversation",
  "sortOrder": 10,
  "active": true,
  "translations": [
    {
      "locale": "en",
      "status": "published",
      "label": "Account tier",
      "placeholder": "Choose a tier"
    }
  ],
  "options": [
    {
      "value": "enterprise",
      "sortOrder": 0,
      "translations": [
        {
          "locale": "en",
          "status": "published",
          "label": "Enterprise"
        }
      ]
    }
  ]
}'

JavaScript

const response = await fetch("https://api.convor.io/api/custom-fields", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_...",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "account_tier",
    "type": "select",
    "required": false,
    "target": "conversation",
    "sortOrder": 10,
    "active": true,
    "translations": [
      {
        "locale": "en",
        "status": "published",
        "label": "Account tier",
        "placeholder": "Choose a tier"
      }
    ],
    "options": [
      {
        "value": "enterprise",
        "sortOrder": 0,
        "translations": [
          {
            "locale": "en",
            "status": "published",
            "label": "Enterprise"
          }
        ]
      }
    ]
  }),
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Create a multilingual custom field definition

Creates a custom field definition for conversations or visitors in the authenticated organization.

POST/api/custom-fields

Endpoint requirements

Credentials: Use either Bearer API key or X-API-Key header.
Required scope: custom-fields:write
Module: Automation & API module (automation_api)
Organization and site scope: Requests can access only resources owned by the authenticated organization. The API does not reveal whether an identifier belongs to another organization or site.
Retry behavior: Convergent write: Retrying leaves the resource in the same resulting state. If the first request succeeded, a later retry may return conflict or not found because the change has already taken effect.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body accepted by this operation.

name*string

Human-readable name.

type*string

Type. Allowed values: text, number, select, checkbox.

required?boolean

Boolean value stored in required.

target?string

Target. Allowed values: conversation, visitor.

sortOrder?integer

Direction used to sort the results.

active?boolean

Whether this resource is active.

translations*array<>

Localized variants for this resource.

options?array<>

List of options.

Response Body

`application/json`

{
  "id": "42880ce7-4d1d-469d-a63e-fd75f2c3e96e",
  "orgId": "8ea0b557-d794-41ce-b86e-44f4780da2b5",
  "name": "account_tier",
  "type": "select",
  "required": false,
  "target": "conversation",
  "sortOrder": 10,
  "active": true,
  "label": "Account tier",
  "placeholder": "Choose a tier",
  "validationMessage": null,
  "locale": "en",
  "fallbackUsed": false,
  "options": [
    {
      "id": "d879cc4e-11ce-46f3-be45-47d20de0a48f",
      "value": "enterprise",
      "sortOrder": 0,
      "label": "Enterprise",
      "locale": "en",
      "fallbackUsed": false,
      "translations": [
        {
          "id": "fc094ad3-b971-438f-9884-ae47e3581e4c",
          "locale": "en",
          "status": "published",
          "sourceLocale": null,
          "machineTranslatedAt": null,
          "reviewedAt": null,
          "reviewedBy": null,
          "createdAt": "2026-08-03T18:00:00.000Z",
          "updatedAt": "2026-08-03T18:00:00.000Z",
          "label": "Enterprise"
        }
      ],
      "createdAt": "2026-08-04T10:00:00.000Z",
      "updatedAt": "2026-08-04T10:00:00.000Z"
    }
  ],
  "translations": [
    {
      "id": "3ff47837-a302-466b-925d-6b53d0bbfb37",
      "locale": "en",
      "status": "published",
      "sourceLocale": null,
      "machineTranslatedAt": null,
      "reviewedAt": null,
      "reviewedBy": null,
      "createdAt": "2026-08-03T18:00:00.000Z",
      "updatedAt": "2026-08-03T18:00:00.000Z",
      "label": "Account tier",
      "placeholder": "Choose a tier",
      "validationMessage": null
    }
  ],
  "createdAt": "2026-08-03T18:00:00.000Z",
  "updatedAt": "2026-08-03T18:00:00.000Z"
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "UNAUTHORIZED",
    "message": "Authentication is required.",
    "correlationId": "req_01K0MANAGEMENT401"
  }
}

{
  "error": {
    "code": "INTEGRATION_MODULE_REQUIRED",
    "message": "The automation API module is required.",
    "details": {
      "module": "automation_api",
      "feature": "public_api"
    },
    "correlationId": "req_01K0MANAGEMENT402"
  }
}

{
  "error": {
    "code": "FORBIDDEN",
    "message": "The caller lacks the required role or API-key scope.",
    "correlationId": "req_01K0MANAGEMENT403"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

{
  "error": {
    "code": "CONFLICT",
    "message": "The requested change conflicts with current resource state.",
    "correlationId": "req_01K0MANAGEMENT409"
  }
}

{
  "error": {
    "code": "VALIDATION_ERROR",
    "message": "The request payload is invalid.",
    "details": {
      "field": "name"
    },
    "correlationId": "req_01K0MANAGEMENT422"
  }
}

{
  "error": {
    "code": "RATE_LIMITED",
    "message": "Too many requests.",
    "correlationId": "req_01K0MANAGEMENT429"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "fields": {
      "property1": "string",
      "property2": "string"
    },
    "details": {},
    "correlationId": "string"
  }
}

Request examples

curl

curl --request POST \
  'https://api.convor.io/api/custom-fields' \
  --header 'Accept: application/json' \
  --header 'Authorization: Bearer convor_sk_...' \
  --header 'Content-Type: application/json' \
  --data '{
  "name": "account_tier",
  "type": "select",
  "required": false,
  "target": "conversation",
  "sortOrder": 10,
  "active": true,
  "translations": [
    {
      "locale": "en",
      "status": "published",
      "label": "Account tier",
      "placeholder": "Choose a tier"
    }
  ],
  "options": [
    {
      "value": "enterprise",
      "sortOrder": 0,
      "translations": [
        {
          "locale": "en",
          "status": "published",
          "label": "Enterprise"
        }
      ]
    }
  ]
}'

JavaScript

const response = await fetch("https://api.convor.io/api/custom-fields", {
  method: "POST",
  headers: {
    "Accept": "application/json",
    "Authorization": "Bearer convor_sk_...",
    "Content-Type": "application/json"
  },
  body: JSON.stringify({
    "name": "account_tier",
    "type": "select",
    "required": false,
    "target": "conversation",
    "sortOrder": 10,
    "active": true,
    "translations": [
      {
        "locale": "en",
        "status": "published",
        "label": "Account tier",
        "placeholder": "Choose a tier"
      }
    ],
    "options": [
      {
        "value": "enterprise",
        "sortOrder": 0,
        "translations": [
          {
            "locale": "en",
            "status": "published",
            "label": "Enterprise"
          }
        ]
      }
    ]
  }),
});

const contentType = response.headers.get("content-type") ?? "";
const data = response.status === 204
  ? null
  : contentType.includes("json")
    ? await response.json()
    : contentType.startsWith("text/")
      ? await response.text()
      : await response.blob();

if (!response.ok) {
  const message = typeof data === "object" && data !== null
    && "error" in data && typeof data.error === "object"
    && data.error !== null && "message" in data.error
      ? String(data.error.message)
      : "Convor API request failed (" + response.status + ")";
  throw new Error(message);
}

console.log(data);

Was this page helpful?

Create a multilingual custom field definition

Endpoint requirements

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Create a multilingual custom field definition

Endpoint requirements

Request Body

Response Body

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

Request examples

curl

JavaScript

On this page

Create a multilingual custom field definition

Endpoint requirements

201application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

Create a multilingual custom field definition

Endpoint requirements

201application/json

400application/json

401application/json

402application/json

403application/json

404application/json

409application/json

422application/json

429application/json

500application/json

On this page

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`