Skip to main content
PATCH
/
api
/
attributes
/
{key}
Update custom attribute
curl --request PATCH \
  --url http://localhost:3000/api/attributes/{key} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "label": "<string>",
  "suggestions": [
    "<string>"
  ],
  "placeholder": "<string>",
  "description": "<string>",
  "operators": [
    "<string>"
  ]
}
'
{
  "statusCode": 123,
  "message": "OK",
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "key": "<string>",
    "label": "<string>",
    "type": "string",
    "category": "user",
    "operators": [
      "<string>"
    ],
    "is_custom": true,
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "suggestions": [
      "<string>"
    ],
    "placeholder": "<string>",
    "description": "<string>",
    "created_by": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

key
string
required

Body

application/json
label
string
suggestions
(string | number)[]
placeholder
string
description
string
operators
string[]

Response

Default Response

statusCode
number
message
string
default:OK
data
object