Dynasend API (2022-08-01)
Download OpenAPI specification:Download
Dynasend serves a REST API. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.
The base URLs for the Dynasend API are:
- Production:
- Sandbox:
Content-Type Header
Content-Type: "application/json"
This object represents a signature of your account.
| id | string Unique identifier for the Signature. |
| object | string Value: "signature" |
| data | object or null Signature properties. |
string Signature's email. | |
| program | object or null Program properties. |
| created_at | string <date-time> Time at which the object was created. Formatting follows RFC339. Example: |
| updated_at | string <date-time> Time at which the object was last updated. Formatting follows RFC339. Example: |
{- "id": "sig_01grz8nvrgem73h57aa9sh8qpq",
- "object": "signature",
- "email": "someone@company.com",
- "created_at": "2021-07-05T12:24:32-03:00",
- "updated_at": "2021-07-05T12:24:32-03:00"
}List all signatures
Oldest signatures will be first on the list.
Authorizations:
query Parameters
| limit | integer Example: limit=20 A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 25. |
| cursor | string Example: cursor=eyJzaWduYXR1cmVzLmlkIjoxMjUwLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9 Pagination cursor |
Responses
Response Schema: application/json
required | Array of objects (Signature) |
object (Response Meta) Pagination links | |
object (Response Meta) Pagination metadata |
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url 'https://manage.dynasend.net/v1/signatures?limit=SOME_INTEGER_VALUE&cursor=SOME_STRING_VALUE' \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
{- "data": [
- {
- "id": "sig_01grz8nvrgem73h57aa9sh8qpq",
- "object": "signature",
- "email": "someone@company.com",
- "data": {
- "first_name": "John",
- "last_name": "Doe",
- "title": "CTO"
}, - "program": {
- "name": "Default Program"
}, - "created_at": "2021-07-05T12:24:32-03:00",
- "updated_at": "2021-07-05T12:24:32-03:00"
}
], - "links": {
- "first": null,
- "last": null,
- "prev": null
}, - "meta": {
- "next_cursor": "eyJzaWduYXR1cmVzLmlkIjoxMjUwLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9",
- "per_page": 25,
- "prev_cursor": "eyJzaWduYXR1cmVzLmlkIjoxMjUwLCJfcG9pbnRzVG9OZXh0SXRlbXMiOnRydWV9"
}
}Retrieve a signature
Retrieve a signature.
Authorizations:
path Parameters
| id required | string Example: 9F6DD766-8454-4CAA-94C3-AAC21DD8FD73 |
Responses
Response Schema: application/json
object (Signature) This object represents a signature of your account. | |||||||||||||||
| |||||||||||||||
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url https://manage.dynasend.net/v1/signatures/9F6DD766-8454-4CAA-94C3-AAC21DD8FD73 \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 404
{- "data": {
- "id": "sig_01grz8nvrgem73h57aa9sh8qpq",
- "object": "signature",
- "data": {
- "first_name": "John",
- "last_name": "Doe",
- "title": "CTO"
}, - "email": "someone@company.com",
- "program": {
- "name": "Default Program"
}, - "created_at": "2022-02-11T23:19:22-03:00",
- "updated_at": "2022-02-11T23:19:22-03:00"
}
}Renders a signature by email
Renders a signature by email
Authorizations:
path Parameters
| format required | string Example: html One of: |
| encoding | string Example: UTF-8 One of: |
Request Body schema: application/jsonrequired
null or string The signature's email address. |
Responses
Response Schema: application/json
object (Rendered Signature) This object represents a rendered signature of your account. | |||
| |||
Request samples
- Payload
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
{- "email": "someone@company.com"
}Response samples
- 200
- 401
- 404
{- "data": {
- "content": "John Doe, \n\nCompany Name\n, \n , , \ntel +1 456 456 XXXX\nmobile +1 456 456 XXXX\nfax +1 456 456 XXXX\njohndoe@company.com\nhttps://example.com\n\nThis email may contain confidential and/or private information. If you received this email in error please delete and notify sender.\n\n"
}
}Renders a signature
Renders a signature
Authorizations:
path Parameters
| id required | string Example: 9F6DD766-8454-4CAA-94C3-AAC21DD8FD73 |
| format required | string Example: html One of: |
| encoding | string Example: UTF-8 One of: |
Responses
Response Schema: application/json
object (Rendered Signature) This object represents a rendered signature of your account. | |||
| |||
Request samples
- Shell + Curl
- Node + Request
- Php + Http1
- Python + Requests
- Java + Unirest
- Ruby + Native
curl --request GET \ --url https://manage.dynasend.net/v1/signatures/9F6DD766-8454-4CAA-94C3-AAC21DD8FD73/render/html/UTF-8 \ --header 'Authorization: Bearer REPLACE_BEARER_TOKEN'
Response samples
- 200
- 401
- 404
{- "data": {
- "content": "John Doe, \n\nCompany Name\n, \n , , \ntel +1 456 456 XXXX\nmobile +1 456 456 XXXX\nfax +1 456 456 XXXX\njohndoe@company.com\nhttps://example.com\n\nThis email may contain confidential and/or private information. If you received this email in error please delete and notify sender.\n\n"
}
}