API key rotated template - EmailsDone Docs

developer Stable Latest stable

API key rotated v1

api-key-rotated - v1

Subject: API key rotated

Preheader: An API key has been rotated.

Required fields

No fields.

Optional fields

Name	Type	Required	Description	Example
`actionButton.label`	text	No	Action Button Label Max 120 characters	`Manage API keys`
`actionButton.url`	url	No	Action Button URL Max 2048 characters	`https://example.com/app`
`apiKeyDetails`	detailsTable	No	API key details Details table keys: `name`, `rotatedAt` (datetime), `environment`, `rotatedBy`	`{"name":"Name","rotatedAt":"Rotated At","environment":"Environment","rotatedBy":"Rotated By"}`
`heading`	text	No	Heading Max 180 characters	`API key rotated`
`intro`	text	No	Intro Max 1000 characters	`An API key has been rotated.`
`preheader`	text	No	Preheader Max 220 characters	`An API key has been rotated.`
`subject`	text	No	Subject Max 180 characters	`API key rotated`

Defaults

{
  "actionButton.label": "Manage API keys",
  "heading": "API key rotated",
  "intro": "An API key has been rotated.",
  "preheader": "An API key has been rotated.",
  "subject": "API key rotated"
}

Example data

{
  "templateId": "api-key-rotated",
  "data": {}
}

Template messages

Type	Code	Message
Return	`accepted`	Valid template data can be queued by the send endpoint.
Error	`field_too_long`	Action Button Label must be 120 characters or fewer.
Error	`field_too_long`	Action Button URL must be 2048 characters or fewer.
Error	`invalid_url`	Action Button URL must be a valid http or https URL.
Error	`invalid_details_table`	API key details must be an object whose documented table keys are strings, numbers, or booleans.
Error	`field_too_long`	Heading must be 180 characters or fewer.
Error	`field_too_long`	Intro must be 1000 characters or fewer.
Error	`field_too_long`	Preheader must be 220 characters or fewer.
Error	`field_too_long`	Subject must be 180 characters or fewer.