CreateConsentGroupRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/brevo/main/json-schema/brevo-create-consent-group-request-schema.json",
  "title": "CreateConsentGroupRequest",
  "description": "Request body for creating a consent group.",
  "x-generated": "2026-10-12",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/brevo-consent-groups-api-openapi.yml#/components/schemas/CreateConsentGroupRequest",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Unique name for the consent group (max 255 characters)"
    },
    "description": {
      "type": "string",
      "description": "Optional description (max 500 characters)"
    },
    "signupMode": {
      "$ref": "#/$defs/CreateConsentGroupRequestSignupMode",
      "description": "Controls how contacts are added to the group. `manual` — contacts are added explicitly via the API. `automatic` — contacts are added automatically at signup."
    },
    "listIds": {
      "type": "array",
      "items": {
        "type": "integer",
        "format": "int64"
      },
      "description": "Optional list of contact list IDs. Contacts from these lists will be copied once into this consent group at creation time."
    }
  },
  "required": [
    "name",
    "signupMode"
  ],
  "$defs": {
    "CreateConsentGroupRequestSignupMode": {
      "type": "string",
      "enum": [
        "manual",
        "automatic"
      ],
      "description": "Controls how contacts are added to the group. `manual` — contacts are added explicitly via the API. `automatic` — contacts are added automatically at signup.",
      "title": "CreateConsentGroupRequestSignupMode"
    }
  }
}