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

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.

Authorization

bearerToken
AuthorizationBearer <token>

Personal access tokens created from the ThriveDesk UI. Create one under Integrations -> API Keys.

In: header

Path Parameters

inbox_id*string

Inbox identifier.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/inboxes/string/custom-fields" \  -H "Content-Type: application/json" \  -d '{    "name": "Order Number",    "type": "text",    "key": "order_number",    "is_required": true,    "is_active": true  }'
{  "message": "string",  "data": {    "id": "string",    "inbox_id": "string",    "name": "string",    "key": "string",    "description": "string",    "type": "text",    "default_value": null,    "is_required": true,    "is_active": true,    "order": 0,    "extra": {},    "options": [      {        "id": "string",        "value": "string"      }    ],    "conditions": [      {}    ],    "created_at": "2019-08-24T14:15:22Z",    "readable_created_at": "string"  }}

Start a new conversation in an inbox POST

Start a new conversation in an inbox.

Delete a custom field DELETE

Delete 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.