Skip to main content
PATCH
Update a group custom field

Authorizations

Authorization
string
header
required

API key for authentication

Path Parameters

groupId
string
required

The identifier of the group. You can retrieve a list of group identifiers using the /v1/groups endpoint.

Required string length: 40
entityType
string
required

The entity type the custom fields belong to. It can be person, company, or a custom object name.

Maximum string length: 500
customFieldName
string
required

The custom field name to update.

Maximum string length: 500

Body

application/json
name
string
Required string length: 1 - 500
config
object
addOptions
object[]

Array of options to add if no duplicated a found.

Required array length: 1 - 100 elements
removeOptions
string[]

Array of option IDs to remove. All data associated to contacts will be removed.

Required array length: 1 - 100 elements
Required string length: 41
updateOptions
object[]

Array of options to update based on their ID.

Required array length: 1 - 100 elements

Response

The updated group custom field.

data
object
required
Example:
deprecations
string[]
Example: