Send the envelope under review
curl --request POST \
--url https://api.atlaswork.ai/api/review/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expectedVersion": 2
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({expectedVersion: 2})
};
fetch('https://api.atlaswork.ai/api/review/send', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.atlaswork.ai/api/review/send"
payload = { "expectedVersion": 2 }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"envelope": {
"id": "<string>",
"organizationId": "<string>",
"teamId": "<string>",
"templateId": "<string>",
"templateContentHash": "<string>",
"version": 123,
"originalFilename": "<string>",
"displayName": "<string>",
"sourceFormat": "<string>",
"contentHash": "<string>",
"sizeBytes": 123,
"deliveryMode": "<string>",
"legalFramework": "<string>",
"consumerDisclosure": true,
"expiresAt": "2023-11-07T05:31:56Z",
"scheduledSendAt": "2023-11-07T05:31:56Z",
"sentAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"declinedAt": "2023-11-07T05:31:56Z",
"voidedAt": "2023-11-07T05:31:56Z",
"expiredAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"reminderPolicy": null,
"metadata": null,
"senderUserId": "<string>",
"senderName": "<string>",
"senderEmail": "<string>",
"detectedParties": null
},
"participants": [
{
"id": "<string>",
"envelopeId": "<string>",
"organizationId": "<string>",
"orderIndex": 123,
"name": "<string>",
"email": "<string>",
"consentedAt": "2023-11-07T05:31:56Z",
"signedAt": "2023-11-07T05:31:56Z",
"declinedAt": "2023-11-07T05:31:56Z",
"declineReason": "<string>",
"lastViewedAt": "2023-11-07T05:31:56Z",
"lastIpAddress": "<string>",
"lastUserAgent": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"company": "<string>",
"title": "<string>",
"detectedPartyIndex": 123
}
],
"fields": [
{
"id": "<string>",
"envelopeId": "<string>",
"organizationId": "<string>",
"participantId": "<string>",
"page": 123,
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"label": "<string>",
"required": true,
"prefillValue": "<string>",
"locked": true,
"value": "<string>",
"filledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"partyIndex": 123
}
]
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}review
Send the envelope under review
The human approval action (spec §5.3): same contract as POST /v1/envelopes/{id}/send, scoped to the token’s envelope — validates the stored document, requires ≥1 participant, transitions to in_progress, and emits the atlas/envelope.sent notification event. Requires a send-capable token (read-only links cannot dispatch).
POST
/
api
/
review
/
send
Send the envelope under review
curl --request POST \
--url https://api.atlaswork.ai/api/review/send \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"expectedVersion": 2
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({expectedVersion: 2})
};
fetch('https://api.atlaswork.ai/api/review/send', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://api.atlaswork.ai/api/review/send"
payload = { "expectedVersion": 2 }
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"envelope": {
"id": "<string>",
"organizationId": "<string>",
"teamId": "<string>",
"templateId": "<string>",
"templateContentHash": "<string>",
"version": 123,
"originalFilename": "<string>",
"displayName": "<string>",
"sourceFormat": "<string>",
"contentHash": "<string>",
"sizeBytes": 123,
"deliveryMode": "<string>",
"legalFramework": "<string>",
"consumerDisclosure": true,
"expiresAt": "2023-11-07T05:31:56Z",
"scheduledSendAt": "2023-11-07T05:31:56Z",
"sentAt": "2023-11-07T05:31:56Z",
"completedAt": "2023-11-07T05:31:56Z",
"declinedAt": "2023-11-07T05:31:56Z",
"voidedAt": "2023-11-07T05:31:56Z",
"expiredAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"reminderPolicy": null,
"metadata": null,
"senderUserId": "<string>",
"senderName": "<string>",
"senderEmail": "<string>",
"detectedParties": null
},
"participants": [
{
"id": "<string>",
"envelopeId": "<string>",
"organizationId": "<string>",
"orderIndex": 123,
"name": "<string>",
"email": "<string>",
"consentedAt": "2023-11-07T05:31:56Z",
"signedAt": "2023-11-07T05:31:56Z",
"declinedAt": "2023-11-07T05:31:56Z",
"declineReason": "<string>",
"lastViewedAt": "2023-11-07T05:31:56Z",
"lastIpAddress": "<string>",
"lastUserAgent": "<string>",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"company": "<string>",
"title": "<string>",
"detectedPartyIndex": 123
}
],
"fields": [
{
"id": "<string>",
"envelopeId": "<string>",
"organizationId": "<string>",
"participantId": "<string>",
"page": 123,
"x": 123,
"y": 123,
"width": 123,
"height": 123,
"label": "<string>",
"required": true,
"prefillValue": "<string>",
"locked": true,
"value": "<string>",
"filledAt": "2023-11-07T05:31:56Z",
"createdAt": "2023-11-07T05:31:56Z",
"updatedAt": "2023-11-07T05:31:56Z",
"partyIndex": 123
}
]
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}{
"code": "<string>",
"message": "<string>",
"details": {}
}Authorizations
HMAC-signed review token (minted into the envelope's review URL at creation), as a bearer token or a token query param. Capabilities are split per token: a read token grants view + draft editing, a send token grants the dispatch action only — so a forwarded review link can be shared read-only. Scoped to exactly one envelope; never valid as a signer credential.
Body
application/json
Required range:
x >= 1⌘I