Signatures
Envelope Reassign
Redirects a received envelope to another user.
- The envelope is identified using the transactionId (tid) query parameter, which can be obtained from the GET /signatures/envelope/list endpoint.
- This endpoint allows the recipient to forward the envelope to another user instead of completing it. email is required and matched case-insensitively against existing recipients. phoneNumber is required only if the current recipient being reassigned has MFA enabled. Only allowed when the current recipient's role is signer and its status is In Progress.
AuthorizationBearer <token>
JWT token to authenticate the request.
In: header
X-Api-Key<token>
API key, sent as a request header.
In: header
Query Parameters
tid?string
Transaction token identifying a specific recipient+envelope pair. Required for anonymous/recipient access (no Authorization header, or the header doesn't resolve to the envelope owner).
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
curl -X POST "https://example.com/signatures/envelope/reassign" \ -H "Content-Type: application/json" \ -d '{ "recipient": { "name": "string", "email": "string", "reason": "string", "phoneNumber": "string" }, "externalContext": {} }'{ "result": { "statusCode": 200, "message": "OK", "data": { "recipient": { "id": "string", "message": "string" } } }, "origin": "string", "dateTime": "string"}{ "error": { "message": "Envelope not found.", "statusCode": 400, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "POST https://apim-mavenheadless-dev-westeu-1.azure-api.net/v1/signatures/envelope/create", "dateTime": "2026-07-20T12:00:00.0000000+00:00"}{ "error": { "message": "Envelope not found.", "statusCode": 400, "innerErrors": [ { "code": "ENVELOPE_ID_INVALID", "message": "Envelope not found.", "userMessage": "Envelope not found." } ] }, "origin": "POST https://apim-mavenheadless-dev-westeu-1.azure-api.net/v1/signatures/envelope/create", "dateTime": "2026-07-20T12:00:00.0000000+00:00"}