Change Custom Field
Intent
Applies the supplied changes to the custom field.
When to call it
Call this when the custom field already exists and its stored values need to change.
Access boundary
Authorize the request with a token that carries custom_fields:write.
Successful result
A successful request returns 200. The response schema below defines the body your integration receives.
Authorizations
Path Parameters
Identifier of the custom field.
Body
- CustomFieldUpdateText
- CustomFieldUpdateNumber
- CustomFieldUpdateDate
- CustomFieldUpdateCheckbox
- CustomFieldUpdateSelect
Schema used to update a custom field of type text.
"text"Metadata map for information your integration needs to retain.
The key must be a string with a maximum length of 40 characters. The value must be either:
- A string with a maximum length of 500 characters
- An integer
- A floating-point number
- A boolean
You can store up to 50 key-value pairs.
Display name assigned to the custom field.
1Slug: Unique organization-wide storage key for this custom field. Use only ASCII letters, numbers, and hyphens.
1^[a-z0-9-_]+$Response
Response: Custom field updated.
- CustomFieldText
- CustomFieldNumber
- CustomFieldDate
- CustomFieldCheckbox
- CustomFieldSelect
Schema for a custom field of type text.
The time Ruba created this record.
The time this record last changed.
The stable identifier for this record.
"text"Slug: Storage key used for this custom field.
Display name assigned to the custom field.
Unique identifier for the organization owning the custom field.
"1dbfc517-0bbf-4301-9ba8-555ca42b9737"