Automations · Custom Fields

Update custom field

Updates a custom field. Fields you leave out keep their current values.

PATCHhttps://api.pozy.ai/v1/custom-fields/{fieldId}
updateCustomField

Guide: Custom fields

Request

Send your API key as Authorization: Bearer pz_live_.... Read-only keys cannot call it. Keys with the accounts resource group disabled get 403 resource_group_disabled. Authentication

Path parameters

NameTypeNotes
fieldIdrequiredstring

Request body

application/json, required

  • namestring
  • optionsarray of string

Example

curl -X PATCH "https://api.pozy.ai/v1/custom-fields/6b748297947f79533fe431a8" \
  -H "Authorization: Bearer $POZY_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "name": "Acme",
  "options": [
    "string"
  ]
}'

Response

200 on success

  • successboolean
  • fieldobject
    • idstring
    • namestring
    • slugstring
    • typestring
    • optionsarray of string
200 response
{
  "success": true,
  "field": {
    "id": "6bfebd43ddc270f6d2c56fc5",
    "name": "Acme",
    "slug": "string",
    "type": "string",
    "options": [
      "string"
    ]
  }
}

Errors

Errors use one shape: { error, type, code, param?, details? }. The ones you are most likely to see here:

400invalid_request_errorA parameter or body field is missing or invalid. param names it.
401authentication_errorThe API key is missing, revoked or expired.
403permission_errorThe key is read-only, scoped to other profiles, or has this resource group disabled.
404not_foundNothing with that id exists in your workspace.
429rate_limit_errorToo many requests this minute. Wait for Retry-After seconds.

Every code is listed in Errors.

More in Custom Fields