Company logoTrust Center Documentation
API v1 ReferenceCustom fieldsId

Update parts of a custom field template

Partially update a custom field template (translations and options included).

PATCH
/api/v1/custom-fields/{id}

Authorization

bearerAuth
AuthorizationBearer <token>

In: header

Path Parameters

id*string

Request Body

application/json

title?string
collection?string
Value in"accounts" | "contacts"
type?string
Value in"text" | "number" | "boolean" | "date" | "select" | "multi_select" | "checkbox"
always_ask?boolean
required?boolean
display?array<>
default_value?string
order?integer
Formatint32
options?array<>
translations?array<>

Response Body

application/json

curl -X PATCH "https://app.orbiqhq.com/api/v1/custom-fields/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "success": true,
  "data": {
    "id": "string",
    "title": "string",
    "collection": "accounts",
    "type": "text",
    "always_ask": true,
    "required": true,
    "display": [
      "header"
    ],
    "default_value": "string",
    "order": 0,
    "options": [
      {
        "value": "string",
        "label": [
          {
            "languages_code": "en-US",
            "translation": "string"
          }
        ]
      }
    ],
    "translations": [
      {
        "languages_code": "en-US",
        "title": "string"
      }
    ]
  }
}
Empty
Empty
Empty
Empty

How is this guide?