Skip to main content
PUT
/
v1
/
custom-fields
/
{customField}
cURL
curl --request PUT \
  --url https://api.comm.com/api/v1/custom-fields/{customField} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "key": "custom1_str"
}
'
{
  "data": {
    "id": "<string>",
    "name": "<string>",
    "key": "<string>",
    "type": "<string>",
    "created_at": "2023-11-07T05:31:56Z"
  }
}

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
customField
string<uuid>
required

The custom field ID

Body

application/json
​
name
string
required
Maximum string length: 255
​
key
enum<string>
required
Available options:
custom1_str,
custom2_str,
custom3_str,
custom4_str,
custom5_str,
custom1_int,
custom2_int,
custom3_int,
custom4_int,
custom5_int,
custom1_dec,
custom2_dec,
custom1_datetime,
custom2_datetime,
custom3_datetime,
custom4_datetime,
custom5_datetime,
foreign_id
Maximum string length: 255

Response

CustomFieldResource

​
data
CustomFieldResource · object
required