Inboxes

Update a custom field

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

PATCH
/inboxes/{inbox_id}/custom-fields/{field_id}

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

field_id*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

name and type are immutable. Sending a changed value for either is rejected with 422.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/inboxes/string/custom-fields/string" \  -H "Content-Type: application/json" \  -d '{    "description": "The customer\'s order reference.",    "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"  }}

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.

Delete a custom view DELETE

Only the teammate who owns the view may delete it, the account owner included. Permanent, and it removes the view for everyone it was shared with. Listing and creating custom views is not part of this surface, so the identifier has to come from a first-party client. 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.