Customer fields

Create field

Creates field_name on the customer with customer_id. Field names may only contain lowercase Latin letters, numbers, and _.

Creates only — it never overwrites. If the field already exists the request fails with 412 and {"errors": {"field_name": ["The field <name> already exists"]}}; use PUT to update an existing field. To set a field without knowing whether it exists, POST first and fall back to PUT on 412.

post/customers/{customer_id}/fields/{field_name}/

Request

  • Base URL: https://api.landbot.io/v1
  • URL: https://api.landbot.io/v1/customers/{customer_id}/fields/{field_name}/
  • Auth: API key in header Authorization

Path parameters

customer_idinteger required

Identifier of the customer.

field_namestring required

Name of the custom field. Only lowercase Latin letters, numbers, and _ are allowed.

Request body

type'string' | 'integer' | 'float' | 'boolean' | 'date' | 'datetime' | 'object' required

date is an ISO 8601 string. datetime is a Unix timestamp. object holds arbitrary JSON — an object or an array — and round-trips as structure rather than as an escaped string; it is the type the builder canvas presents as array/list. An unrecognised type string is not rejected: the value is silently coerced and stored as string.

extraobject

Optional extra metadata. Pass {} if not used.

Response

Field created.

successboolean

Changes

No recorded changes to this operation across all 1 revision of this API.