Create Session From Template

Create a new signing session from a template. This endpoint allows you to generate a session based on a template and specify recipients.

Endpoint

POST https://api.airsign.com.au/api/v1/SessionFromTemplate

Headers

Name	Value	Required	Description
Content-Type	application/json	Yes	Specifies the format of the request body
Authorization	Bearer {access_token}	Yes	Bearer token obtained from authentication

Request Body

Parameter	Type	Required	Description
templateId	string	Yes	The ID of the template to use, must be active
name	string	Yes	Name of the session
sendImmediately	boolean	Yes	Whether to send invitations immediately or leave in draft
recipients	array	Yes	List of recipient objects (name, email)

Example (application/json):

{
  "templateId": "2bc7fc6a-2b90-44f4-9889-d8f7673f5f4f",
  "name": "api test multirecipient",
  "sendImmediately": true,
  "recipients": [
    {
      "name": "test1",
      "email": "{valid_email}"
    }
  ]
}

Example Request

curl --location 'https://api.airsign.com.au/api/v1/SessionFromTemplate' --header 'Content-Type: application/json' --header 'Authorization: Bearer {access_token}' --data-raw '{
    "templateId": "{uuid}",
    "name": "api test multirecipient",
    "sendImmediately": true,
    "recipients": [{
        "name": "test1",
        "email": "{valid_email}"
    }]
}'

Response

Status: 200 OK

{
    "name": "Api Test",
    "sessionId": "{uuid}",
    "status": "pending",
    "selfSignOnly": false,
    "createdAt": "2025-07-02 16:19:36",
    "completedDate": null,
    "updatedAt": "2025-07-02 16:19:36",
    "files": [
        {
            "fileId": "{uuid}",
            "fileName": "{file_name}.pdf",
            "fileType": "application/octet-stream",
            "namespace": "templateDocuments",
            "zones": [
                {
                    "id": "{uuid}",
                    "name": "signingZone3315",
                    "type": "signingZone",
                    "label": "Sign",
                    "page": 1,
                    "recipientId": "default",
                    "x": 29.17,
                    "y": 38.01,
                    "w": 100,
                    "h": 50
                },
                {
                    "id": "{uuid}",
                    "name": "signingZone4881",
                    "type": "signingZone",
                    "label": "Sign",
                    "page": 1,
                    "recipientId": "recipient-1-1751421338960",
                    "x": 153.57,
                    "y": 15.35,
                    "w": 100,
                    "h": 50
                }
            ],
            "sessionId": "{uuid}",
            "importedZones": true
        }
    ],
    "recipients": [
        {
            "recipientId": "default",
            "status": "pending",
            "name": "test1",
            "email": "{valid_email}"
        }
    ]
}