THthrivedesk
Inboxes

Create a custom field

Create a custom field.

Personal access token only. The API supports a second, partner-issued token class that is not part of the public surface. This endpoint does not accept that class.

post/inboxes/{inbox_id}/custom-fields

Request

  • Base URL
    https://api.thrivedesk.com/v1
  • Auth
    HTTP bearer

Path parameters

inbox_idstring required

Inbox identifier.

Request body

namestring required
type'text' | 'textarea' | 'dropdown' | 'toggle' | 'number' required
keystring required

Unique per inbox.

descriptionstring nullable
is_requiredboolean
is_activeboolean
default_valueunknown
optionsstring[]

Only for dropdown fields, rejected for other types.

Response

Success.

messagestring required

Example response

{
  "message": "Custom field created successfully",
  "data": {
    "id": "4f5e6d7c-8b9a-4c0d-9e1f-2a3b4c5d6e7f",
    "inbox_id": "3f7c1e94-2b6a-4d0e-8c5f-9a1b2c3d4e5f",
    "name": "Order Number",
    "key": "order_number",
    "description": "The customer's order reference.",
    "type": "text",
    "default_value": null,
    "is_required": true,
    "is_active": true,
    "order": 1,
    "extra": null,
    "options": [],
    "conditions": [],
    "created_at": "2026-07-10T09:00:00Z",
    "readable_created_at": "Jul 10, 2026"
  }
}

Changes

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