Customer fields

Change field

Updates the value of field_name for the customer with customer_id. Field names may only contain lowercase Latin letters, numbers, and _.

The field must already exist. PUT does not create — use POST for that. A PUT against a field that was never created returns 404, and that 404 is an HTML page rather than the usual JSON error envelope, so do not assume the response body parses as JSON.

put/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 updated.

successboolean

Changes

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