Sign in

v4

OpenAPI 3.1.02026-07-3163216290.7 KB
Transactional groups

Create a transactional group

Create a new transactional group.

post/v1/transactional-groups

Request body

namestring required

The group name. Cannot be the reserved name "Unsorted".

descriptionstring

An optional description for the group.

Example request

{
  "name": "Newsletters",
  "description": "Monthly newsletter campaigns"
}

Response

Transactional group created.

idstring required

The ID of the group.

namestring required

The name of the group.

descriptionstring required

The description of the group.

createdAtstring date-time required

ISO 8601 timestamp for when the group was created.

updatedAtstring date-time required

ISO 8601 timestamp for when the group was last updated.

Example response

{
  "id": "clg7n5p3q1r9s7t5u3v1w9y7",
  "name": "Onboarding",
  "description": "Top of funnel campaigns",
  "createdAt": "2025-06-29T07:47:39.370Z",
  "updatedAt": "2025-06-29T07:47:39.370Z"
}