Update a letter's publication status
POST
/api/v3/letters/{letterUuid}/update-status
const url = 'https://api.tryletterhead.com/api/v3/letters/example/update-status';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"publicationStatus":9}'};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request POST \ --url https://api.tryletterhead.com/api/v3/letters/example/update-status \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "publicationStatus": 9 }'Change a letter’s publication status. This is the narrower alternative updateALetter points to
when you only need to move a letter between statuses rather than round-tripping the whole letter.
Scheduling and sending a letter to go out are not done through this endpoint — use the
send/schedule endpoints for that. publicationStatus here is restricted to the template-lifecycle
statuses: 3 (template), 8 (configuring), or 9 (configured).
Authorizations
Section titled “Authorizations ”Parameters
Section titled “ Parameters ”Path Parameters
Section titled “Path Parameters ” letterUuid
required
string
The letter’s unique identifier — an alphanumeric string around ten characters, e.g. ludctamgd6.
Request Body required
Section titled “Request Body required ” Media type application/json
object
publicationStatus
required
One of 3 (template), 8 (configuring), 9 (configured).
integer
Example
{ "publicationStatus": 9}Responses
Section titled “ Responses ”Letter status updated
Media type application/json
string
Example
Letter status updated.Still can’t find what you need? Contact support.