Create a new consent group

post

https://{your_connecttenant_apidomain }/v1/groups

Use this method for creating a new multi-channel consent group. Note- Replace {your_connecttenant_apidomain } in the URL with your hostname to try this API with your environment. See Know your endpoint page.

Body Params

The request body outlines the desired configuration for a new consent group.

name

string

required

length between 1 and 128

The unique name of the group.

description

string

required

A text description for this consent group.

maxFrequencies

array of objects

length between 0 and 10

Array of objects describing the maximum frequency of contacts for a given channel over a given period of time.

maxFrequencies

senders

array of objects

required

length between 1 and 10

Array of allowed sending addresses for this consent group to send from.

senders*

channel

string

enum

required

A channel of communication

Allowed:

address

string

Address for communications sent on this channel.

groupDefault

string

enum

required

The default control type for addresses to be contacted.

Allowed:

createdBy

string

Identity to track the creator of the group.

Response

Language

Credentials

URL

Response

Click Try It! to start a request and see the response here! Or choose an example:

text/plain

201Group has been successfully created with the specified ID.