Send template
Send this template to signers via the API
- Overview
-
This endpoint allows you to use a template via the API.
To get started, you will need to set who the signers are, name & email. You must set a signer for each role you have created.
- Setting a signer also updates any name and email fields
- Fields of the type datesigned will automatically update when the signer signs.
- A signer must have a valid email and name
- Reminder days is counted in days from the document was sent
eg 1 day = 24 hours from send - Duplicate (manual templates) - is always true. Duplicate template and send
- Duplicate (API uploaded PDFs) - false, API consumes template and sends it. Set duplicate=true to send this document to a batch of people
- You can pre-fill in form inputs and labels (eg title, role, company etc) by setting the fields array in the JSON.
- You can rename the main document using 'doc_name', to rename the extra documents (attachments), use 'attachment_names_in_order'
- Use the metadata field for any custom data, arrays or objects
- Any json node that starts info_ is purely for information below, you can ommit it from you request
You can find the OpenAPI 3.1 specification for the JSON parameters on goodsign.stoplight.io
- End Point
- https://goodsign.io/api/usetemplate
- Method
- POST
- Authentication
- Bearer your_api_token
-
Example JSON PayLoad
Set signers -
{ "uuid": null, "doc_name": "F - Depreciation Schedule.pdf", "attachment_names_in_order": [], "metadata": [ "any valid json works" ], "webhook": "", "cc_email": "", "smsverify(optional)": "boolean true or false", "send_in_order(optional)": "boolean true or false", "duplicate(optional)": "boolean default true for manually created template, false for PDFs loaded via api", "email_subject(optional)": "{fullname} has requested your signature on {docname}", "email_message(optional)": "extra message to include, not required", "fields(optional)": [] }
-
Working Curl Request
Uses JSON and signers from above.
(excludes fields, metadata, webhook) -
curl --request POST \ --url https://goodsign.io/api/usetemplate \ --header 'authorization: Bearer YOUR_API_TOKEN' \ --data '{"uuid":null,"doc_name":"F - Depreciation Schedule.pdf","attachment_names_in_order":[],"metadata":["any valid json works"],"webhook":"","cc_email":"","smsverify(optional)":"boolean true or false","send_in_order(optional)":"boolean true or false","duplicate(optional)":"boolean default true for manually created template, false for PDFs loaded via api","email_subject(optional)":"{fullname} has requested your signature on {docname}","email_message(optional)":"extra message to include, not required"}'