POST /contacts/consent-groups

Creates a new consent group for the account.

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

Servers

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
name String Yes

Unique name for the consent group (max 255 characters)

description String No

Optional description (max 500 characters)

listIds[] Array No

Optional list of contact list IDs. Contacts from these lists will be copied once into this consent group at creation time.

signupMode String Yes

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

Valid values:

  • "manual"
  • "automatic"

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.