> **Source:** https://knowledge.leegality.com/document-execution/api/activate-invitation > **Site:** Leegality Knowledge Base — https://knowledge.leegality.com > **About:** Leegality is a document execution platform covering eSigning, stamps, NeSL, workflows, and REST API integration. > **Navigation:** Every article on this site has a plain-text version at `.txt` (this format). To get an index of all articles with their `.txt` links, read: https://knowledge.leegality.com/llms.txt > **AI Guide:** For instructions on how to navigate this knowledge base as an AI agent, read: https://knowledge.leegality.com/ai-readable.txt --- # PUT /v3.1/invitation/activate — Activate invitation Activates an invitation that is not yet active due to a pre-defined signing order. Use this API to enable invitations out of turn — for example, when an earlier signer is unable to sign and you want subsequent signers to proceed. **Authentication:** `X-Auth-Token` header required on every request. ## Request URL ``` PUT https://app1.leegality.com/api/v3.1/invitation/activate?signUrl={signUrl} ``` **Environments:** - Production: `https://app1.leegality.com/api/v3.1/invitation/activate` - Sandbox: `https://sandbox.leegality.com/api/v3.1/invitation/activate` --- ## Parameters | Name | In | Required | Type | Description | Example | |------|----|----------|------|-------------|---------| | `signUrl` | query | Yes | string | The sign URL (invitation URL) of the inactive invitation to activate. The invitation URL is returned in the Create eSigning Request API response for each invitee. Accepts either the full URL (e.g., `https://sandbox.leegality.com/sign/544bf18f-...`) or just the UUID portion (e.g., `544bf18f-91b8-4afb-96ee-8ff1927a2726`). | — | --- ## Responses ### 200 — Default Response Response for the Activate Invitation API. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `status` | integer | No | API response status. `1` = Success — the invitation has been activated `0` = Failure — check the `messages` array for error details | `1` | | `data` | object | No | Empty object `{}` for both success and error responses. | `[object Object]` | | `messages` | array\ | No | Array of messages. Unlike most other APIs, this field contains a message on **both success and failure**. **Success code:** - `invitation.activate.success` — Invitation activated successfully. The invitee will receive a notification to sign. **Error codes:** - `sign.url.required` — The `signUrl` parameter is missing or empty - `invitation.not.found` — The sign URL is invalid or you do not have access to the document - `invitation.already.activated` — The invitation is already active (no action needed) - `invitation.signed` — The invitation has already been completed (signed/approved) - `invitation.expired` — The invitation has expired. Use the [Reactivate document](https://knowledge.leegality.com/document-execution/api/reactivate-document) API to reactivate expired invitations - `invitation.completed` — The document has already been completed (all signatures collected) - `invitation.manual.activation.not.allowed` — NeSL invitations cannot be manually activated - `sign.invitation.rejected` — The invitation was rejected by the signer. Re-invite the signer first See **Message** below. | — | #### Message Message object containing a machine-readable code and a human-readable description. Used for success confirmations, errors, and warnings. | Field | Type | Required | Description | Example | |-------|------|----------|-------------|---------| | `code` | string | No | Response message code. | `simpleWorkFlow.success` | | `message` | string | No | Human-readable success or error message. | `Invitations sent successfully.` | ### Sample Response (200) ```json { "status": 1, "data": {}, "messages": [ { "code": "simpleWorkFlow.success", "message": "Invitations sent successfully." } ] } ```