Schedule letter

POST

/api/v2/letters/{letterUuid}/actions/schedule

Schedule an existing letter by its unique identifier, or generate and schedule a new letter by using the unique identifier of a template.

What is the letter or template’s unique identifier? The unique identifier is an alphanumeric string, often around ten digits. It looks like abcdefhijk.

How does the API behave when a given letter or template has a specific status?

• If the letter is a draft, or it’s already been scheduled but not yet published, then Letterhead will reschedule that letter for the desired time.
• If the letter has already been published, then Letterhead won’t resend it, and the API will return a 400 .
• If the template is active, then Letterhead will use that template to create an all-new email, produce it, and schedule it at the desired time.
• If the template is inactive, however, then Letterhead will assume your organization doesn’t want it used and our API will return a 400.

Authorizations

• bearerAuth

Parameters

Path Parameters

letterUuid

required

string

Request Body

Media type multipart/form-data

object

date

required | Declare the time to schedule the campaign for delivery in ISO 8601 format.

Example: 2024-05-29T15:15:00

The time is locale to the Channel’s timezone, for now, and must be at least 5 minutes in the future.

string

Example

{{ publicationDate }}

segment

required | Identify the audience segment you wish to target by passing its identifier. If you pass null, the Letter will send to its entire audience.

string

Example

{{ segmentUuid }}

subject

optional | Set the subject of your letter. If not present, the letter’s subject will be dynamically set based on the first heading found in the content.

string

Example

Responses

200