Skip to navigation
Contact ManagementConsent groups

Update a consent group

View as Markdown

Updates name, description, or signupMode of a consent group. At least one field must be provided.

This endpoint is only available when the Consent Groups feature is enabled for your account.

Authentication

api-keystring

The API key should be passed in the request headers as api-key for authentication.

OR
AuthorizationBearer

OAuth 2.0 client_credentials (machine-to-machine) grant. Exchange your app’s client_id/client_secret for a short-lived Bearer token.

Path parameters

idlongRequired
ID of the consent group to update

Request

This endpoint expects an object.
namestringOptional

New name for the consent group (max 255 characters)

descriptionstringOptional

New description (max 500 characters)

signupModeenumOptional
New signup mode
Allowed values:

Response

Updated consent group
idlong
Unique identifier for the consent group
namestring
Display name of the consent group
signupModeenum

Controls how contacts are added to the group. manual — contacts are added explicitly via the API. automatic — contacts are added automatically at signup.

Allowed values:
contactsCountlong
Number of contacts currently in this consent group
isDefaultboolean

Whether this is a system-created default consent group

createdAtdatetime

UTC date-time when the consent group was created (YYYY-MM-DDTHH:mm:ss.SSSZ)

updatedAtdatetime

UTC date-time when the consent group was last updated (YYYY-MM-DDTHH:mm:ss.SSSZ)

descriptionstringOptional
Optional description of the consent group

Errors

400
Bad Request Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error