Sign in

v4

OpenAPI 3.1.02026-07-3163216290.7 KB
Transactional emails

Update a transactional email

Update a transactional email by ID.

post/v1/transactional-emails/{transactionalId}

Request body

namestring
transactionalGroupIdstring

The ID of the group to move this transactional email to.

Example request

{
  "name": "Password reset email",
  "transactionalGroupId": "clg7n5p3q1r9s7t5u3v1w9y7"
}

Response

Transactional email updated.

idstring required

The ID of the transactional email.

namestring required

The name of the transactional email.

draftEmailMessageIdstring nullable required

The ID of the draft email message. null if there is no draft version.

publishedEmailMessageIdstring nullable required

The ID of the published email message. null if there is no published version.

transactionalGroupIdstring nullable required

The ID of the group this transactional email belongs to.

createdAtstring date-time required

ISO 8601 timestamp for when the transactional email was created.

updatedAtstring date-time required

ISO 8601 timestamp for when the transactional email was last updated.

dataVariablesstring[] required

Data variable names used by the published email. Empty for unpublished transactional emails.

Example response

{
  "id": "cll42l54f20i1la0lfooe3z12",
  "name": "Sign up confirmation",
  "draftEmailMessageId": "cle5f7g9h1i3j5k7l9m1n3p5",
  "publishedEmailMessageId": "cle5f7g9h1i3j5k7l9m1n3p5",
  "transactionalGroupId": "clg7n5p3q1r9s7t5u3v1w9y7",
  "createdAt": "2025-06-29T07:47:39.370Z",
  "updatedAt": "2025-06-29T07:47:39.370Z",
  "dataVariables": [
    "confirmationUrl"
  ]
}