Ricky logorickyDocs

Create a contact field

POST
/contact-fields

Adds a custom field to every contact, after the existing ones. A name already in use, in any case, answers 409 conflict.

Scope: contacts:write.

Authorization

bearerAuth
headerAuthorizationBearer <token>

An organization API key, rky_live_…, created in Settings → API. Send it only from a server.

Header Parameters

Idempotency-Key?string

Optional. A value you choose, unique per logical write, 8–200 characters: a UUID or an ID from your system such as order-10482-ready. Retrying with the same key and body replays the first response instead of repeating the write.

Length8 <= length <= 200

Request Body

application/json
  1. body

A custom contact field. Its ID keys custom_values.

name*string

Display name, unique in the organization regardless of case.

Length1 <= length <= 60
type*string

Value type. It cannot change later.

Value in"text""long_text""number""boolean""date""select""multi_select"
options?array<>

Allowed values; required for select and multi_select, refused otherwise.

Itemsitems <= 100

Response Body

Success.

application/json
  1. response
data*

A custom contact field defined by the organization.

curl -X POST 'https://getricky.ai/api/v1/contact-fields' \  -H 'Idempotency-Key: order-10482-ready' \  -H 'Content-Type: application/json' \  -d '{  "name": "Sucursal",  "type": "select",  "options": [    "Albrook Mall",    "Multiplaza"  ]}'
{  "data": {    "id": "1a2b3c4d-5e6f-4a7b-8c9d-0e1f2a3b4c5d",    "name": "Sucursal",    "type": "text",    "options": [      "Albrook Mall",      "Multiplaza"    ]  }}