Update a letter's permissions
POST
/api/v3/letters/{letterUuid}/permissions
const url = 'https://api.tryletterhead.com/api/v3/letters/example/permissions';const options = { method: 'POST', headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'}, body: '{"allowAdd":true,"allowClone":true,"allowDelete":false,"allowMove":true}'};
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/permissions \ --header 'Authorization: Bearer <token>' \ --header 'Content-Type: application/json' \ --data '{ "allowAdd": true, "allowClone": true, "allowDelete": false, "allowMove": true }'Update which editing actions are allowed on a letter — adding blocks, cloning, deleting, and
reordering (moving) blocks. This is the narrower alternative updateALetter points to when you
only need to change permissions rather than round-tripping the whole letter.
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
allowAdd
(optional) Whether new blocks can be added to the letter.
boolean
allowClone
required
boolean
allowDelete
required
boolean
allowMove
(optional) Whether existing blocks can be reordered.
boolean
Example
{ "allowAdd": true, "allowClone": true, "allowDelete": false, "allowMove": true}Responses
Section titled “ Responses ”Permissions updated
Still can’t find what you need? Contact support.