Unschedule letter
POST
/api/v2/letters/{letterUuid}/actions/unschedule
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
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” letterUuid
required
string
Request Body
Section titled “Request Body ” Media type multipart/form-data
object
Responses
Section titled “ Responses ”Still can’t find what you need? Contact support.