Updates an existing consent group.

put

https://example.com/v1/groups/{groupId}

This method updates an existing consent group for a specified groupId.

Path Params

groupId

string

required

Unique ID of group

Body Params

The request body outlines the desired configuration for the 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.

status

string

enum

required

The state of the group to indicate if currently enabled or disabled.

Allowed:

Responses

200

Consent group updated successfully

404

Invalid or unknown group ID.

410

The group has been deleted.

Language

Credentials

Loading…

Response

Click Try It! to start a request and see the response here!