consentGroups

Create a consent group

Creates a new consent group for the account.

<Note>This endpoint is only available when the Consent Groups feature is enabled for your account.</Note>

post/contacts/consent-groups

Request

  • Base URL: https://api.brevo.com/v3
  • URL: https://api.brevo.com/v3/contacts/consent-groups
  • Auth: API key in header api-key

Request body

namestring required

Unique name for the consent group (max 255 characters)

descriptionstring

Optional description (max 500 characters)

signupMode'manual' | 'automatic' required

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

listIdsinteger[]

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

Response

Consent group created successfully

idinteger required

Unique identifier for the consent group

namestring required

Display name of the consent group

descriptionstring

Optional description of the consent group

signupMode'manual' | 'automatic' required

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

contactsCountinteger required

Number of contacts currently in this consent group

isDefaultboolean required

Whether this is a system-created default consent group

createdAtstring date-time required

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

updatedAtstring date-time required

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

Changes

No recorded changes to this operation across all 1 revision of this API.