v1
latestOpenAPI 3.1.02026-07-24560263.9 KBCriar Envelope
Setup do envelope
post/envelopes
Headers
Authorizationstring required
Access Token gerado pelo gestor da conta
Content-type'application/vnd.api+json' required
Content-type padrão para todas requisições JSON:API
Response
201
Example response
{
"data": {
"id": "6bb80fa1-4836-424a-9441-0108a7c54d04",
"type": "envelopes",
"links": {
"self": "https://sandbox.clicksign.com/api/v3/envelopes/6bb80fa1-4836-424a-9441-0108a7c54d04"
},
"attributes": {
"name": "teste",
"status": "draft",
"deadline_at": "2024-03-30T09:17:36.417-03:00",
"locale": "pt-BR",
"auto_close": true,
"rubric_enabled": true,
"remind_interval": 3,
"created": "2024-02-29T09:17:36.418-03:00",
"modified": "2024-02-29T09:17:36.458-03:00"
},
"relationships": {
"documents": {
"links": {
"self": "https://sandbox.clicksign.com/api/v3/envelopes/6bb80fa1-4836-424a-9441-0108a7c54d04/relationships/documents",
"related": "https://sandbox.clicksign.com/api/v3/envelopes/6bb80fa1-4836-424a-9441-0108a7c54d04/documents"
}
},
"signers": {
"links": {
"self": "https://sandbox.clicksign.com/api/v3/envelopes/6bb80fa1-4836-424a-9441-0108a7c54d04/relationships/signers",
"related": "https://sandbox.clicksign.com/api/v3/envelopes/6bb80fa1-4836-424a-9441-0108a7c54d04/signers"
}
},
"requirements": {
"links": {
"self": "https://sandbox.clicksign.com/api/v3/envelopes/6bb80fa1-4836-424a-9441-0108a7c54d04/relationships/requirements",
"related": "https://sandbox.clicksign.com/api/v3/envelopes/6bb80fa1-4836-424a-9441-0108a7c54d04/requirements"
}
}
}
}
}