Template links API
The settings behind a template's public fill link: whether it is on, what it asks for, and the token that addresses it. The fill link itself is a page a signer opens, not an API call.
Updated
On this page
3 operations, generated from
openapi/signclad.v1.yaml. Try them in the
interactive reference, browse
every endpoint group, or read the
guides for the prose version.
- GET
/template_links/{template}Get a template's link settings - PUT
/template_links/{template}Update a template's link settings - POST
/template_links/{template}/rotateRotate a template's link
GET /template_links/{template}
Get a template's link settings Extension
The public URL and the rules behind it. A link exists from the moment the template does; it
is enabled: false until somebody turns it on.
- Base URL
https://api.signclad.com/api/v1- Authentication
- API key or OAuth 2.1 access token or Session
Path parameters
| Name | Type | Description |
|---|---|---|
template | string (uuid) | The template's id. |
Responses
| Status | Description |
|---|---|
200 | The link and its settings. |
401 | Missing or invalid credentials. Unauthenticated requests are rate limited at 50 per minute.… |
403 | Authenticated, but not allowed to do this: an insufficient role, a credential type the route refuses, or a signer acting out of turn. meta.error always says which.… |
404 | No such record for this workspace. Signclad never answers 404 for a record that exists: a 404 is authoritative. |
422 | The request was well formed; the account may not make it right now.… |
Example request
curl -X GET https://api.signclad.com/api/v1/template_links/{template} \
-H "X-Api-Key: $SIGNCLAD_API_KEY" PUT /template_links/{template}
Update a template's link settings Extension
A partial merge despite being a PUT: only the keys present change. redirect_url must be
HTTPS. An expires_at in the past is accepted — it simply makes the link unusable, which is
a reasonable way to switch one off.
- Base URL
https://api.signclad.com/api/v1- Authentication
- API key or OAuth 2.1 access token or Session
Path parameters
| Name | Type | Description |
|---|---|---|
template | string (uuid) | The template's id. |
Request body
application/json
| Property | Type | Required | Description |
|---|---|---|---|
enabled | boolean | Optional | A link exists as soon as the template does, switched off. |
expires_at | string or null | Optional | A time in the past is accepted, and makes the link unusable. |
notify_sender | boolean | Optional | |
redirect_url | string or null | Optional | Must be HTTPS. |
require_name_email | boolean | Optional | |
single_use | boolean | Optional |
Responses
| Status | Description |
|---|---|
200 | The updated link. |
401 | Missing or invalid credentials. Unauthenticated requests are rate limited at 50 per minute.… |
403 | Authenticated, but not allowed to do this: an insufficient role, a credential type the route refuses, or a signer acting out of turn. meta.error always says which.… |
404 | No such record for this workspace. Signclad never answers 404 for a record that exists: a 404 is authoritative. |
422 | Validation failed. errors maps a field name to a message string, or to an object keyed by an error code or by a per-item key. Values are never arrays. |
Example request
curl -X PUT https://api.signclad.com/api/v1/template_links/{template} \
-H "X-Api-Key: $SIGNCLAD_API_KEY" POST /template_links/{template}/rotate
Rotate a template's link Extension
Issues a new token and kills the old URL immediately. This is the answer to a link that leaked: the settings survive, the address does not.
- Base URL
https://api.signclad.com/api/v1- Authentication
- API key or OAuth 2.1 access token or Session
Path parameters
| Name | Type | Description |
|---|---|---|
template | string (uuid) |
Responses
| Status | Description |
|---|---|
200 | The link, at its new address. |
401 | Missing or invalid credentials. Unauthenticated requests are rate limited at 50 per minute.… |
403 | Authenticated, but not allowed to do this: an insufficient role, a credential type the route refuses, or a signer acting out of turn. meta.error always says which.… |
404 | No such record for this workspace. Signclad never answers 404 for a record that exists: a 404 is authoritative. |
422 | The request was well formed; the account may not make it right now.… |
Example request
curl -X POST https://api.signclad.com/api/v1/template_links/{template}/rotate \
-H "X-Api-Key: $SIGNCLAD_API_KEY"