All Smarter Drafter API Resources can be found here
Aliases
Aliases are a unique, human-readable string used to map data across forms, fields and sections
| Resource | Description |
|---|---|
| GET /Aliases/:id | Returns a specified alias |
| PUT /Aliases/:id | Updates a specified alias |
| DELETE /Aliases/:id | Deletes a specified alias |
| GET /Aliases | Search for an alias with a query parameter |
| POST /Aliases | Creates a new alias |
API Keys
API Keys are unique keys authenticated against your Smarter Drafter Pro account to securely access Smarter Drafter's API endpoints
| Resource | Description |
|---|---|
| GET /ApiKeys | Returns API keys associated with the current user's account |
| POST /ApiKeys | Creates a new API Key for a specified tenant |
| PUT /ApiKeys/:id | Updates the name of a specific API Key |
| PUT /ApiKeys/:id/Reactivate | Reactivate a specific API Key |
| PUT /ApiKeys/:id/Deactivate | Deactivate a specific API Key |
Conditional Rules
Conditional Rules are used in automations to insert conditional content
| Resource | Description |
|---|---|
| GET /NamedRanges/:id | Returns a specified conditional rule |
| PUT /NamedRanges/:id | Updates a specified conditional rule |
| DELETE /NamedRanges/:id | Deletes a specified conditional rule |
| GET /NamedRanges | Search for conditional rules using query parameters |
| POST /NamedRanges | Creates a new conditional rule |
Contacts
Contacts are used to send forms to users, and can be synced between integrations and Smarter Drafter
| Resource | Description |
|---|---|
| GET /Contacts/:id | Returns a specified contact |
| PUT /Contacts/:id | Updates a specified contact |
| DELETE /Contacts/:id | Deletes a specified contact |
| GET /Contacts | Search for contacts |
| POST /Contacts | Creates a new contact |
Fields
Fields are used to create questions and sections in automations
| Resource | Description |
|---|---|
| GET /Fields/:formId | Retrieves fields by form ID |
| GET /Fields | Search for fields with query parameters |
| POST /Fields | Add a new field |
| PUT /Fields/:id | Update a specified field |
| DELETE /Fields/:id | Delete a specified field |
Folders
Folders are used to organise forms
| Resource | Description |
|---|---|
| GET /Folders/Library | Gets the library of client folders |
| POST /Folders | Adds a new folder |
| PUT /Folders/:id | Updates a specified folder |
| DELETE /Folders/:id | Delete a specified folder |
Form Roles
Form Roles are used to map fields to a single entity, which can be shared across other forms
| Resource | Description |
|---|---|
| GET /FormRoles/:id | Returns a specified form role |
| PUT /FormRoles/:id | Updates a specified form role |
| DELETE /FormRoles/:id | Deletes a specified form role |
| GET /FormRoles | Search for form roles with query parameters |
| POST /FormRoles | Creates a new form role |
Forms
Forms are built as an automation using fields, and are sent to users to complete
| Resource | Description |
|---|---|
| GET /Forms/:id/Fields | Returns fields from a specified form |
| GET /Forms/:id | Returns a specified form |
| PUT /Forms/:id | Updates a specified form |
| GET /Forms | Search for forms with specified query parameters |
| POST /Forms | Creates a new forms |
| GET /Forms/:id/FieldOverwrites | Retrieves field overwrites associated with a child form |
| PUT /Forms/:id/FieldOverwrites/:fieldRef | Overwrite a specified field in a form |
| DELETE /Forms/:id/FieldOverwrites/:fieldRef | Delete a specified field in a form |
| PUT /Forms/:id/SectionOverwrites/:sectionId/:hidden | Overwrite specified field in a section in a form |
| DELETE /Forms/:id/:permanently | Deletes a specified form |
| DELETE /Forms/:id/FieldOverwrites/:fieldRef/Options/:optionRef | Deletes an option overwrite in a field overwrite of a form. |
Form Templates
Form Templates are .docx files used to generate a completed form
| Resource | Description |
|---|---|
| GET /FormTemplates/:id | Returns a specified form template |
| PUT /FormTemplates/:id | Updates a specified form template |
| DELETE /FormTemplates/:id | Deletes a specified form template |
| GET /FormTemplates/:id/Download | Downloads a specified form template |
| GET /FormTemplates | Search for a form template using query parametes |
| POST /FormTemplates | Add a new form template |
Option Set
Option Sets are the options that can be selected from radio, checkbox or select fields in Smarter Drafter Pro
| Resource | Description |
|---|---|
| GET /OptionSets/:id | Returns a specific option set |
| PUT /OptionSets/:id | Update a specific option set |
| DELETE /OptionSets/:id | Delete a specific option set |
| GET /OptionSets | Search for option sets using query parameters |
| POST /OptionSets | Creates a new option set |
PMS Field Map
PMS Field Maps are the mappings of Smarter Drafter Fields to integrations such as Actionstep and Unity
| Resource | Description |
|---|---|
| GET /PmsFieldMap/:id | Returns a specific PMS field mapping |
| PUT /PmsFieldMap/:id | Update a specific PMS field mapping |
| DELETE /PmsFieldMap/:id | Delete a specific PMS field mapping |
| GET /PmsFieldMap | Search for PMS field mappings using query parameters |
| POST /PmsFieldMap | Creates a new PMS field mapping |
Replacement Rules
Replacement Rules are used in automations to find-and-replace content in document generation
| Resource | Description |
|---|---|
| GET /ReplacementRules/:id | Returns a specified replacement rule |
| PUT /ReplacementRules/:id | Updates a specified replacement rule |
| DELETE /ReplacementRules/:id | Deletes a specified replacement rule |
| GET /ReplacementRules/Default | Gets all default replacement rules |
| GET /ReplacementRules | Search for replacement rules using query parameters |
| POST /ReplacementRules | Creates a new replacement rule |
Snippets
Snippets are used to insert re-usable content into templates during document generation
| Resource | Description |
|---|---|
| GET /Snippets | Search for snippets using query parameters |
| POST /Snippets | Creates a new snippet |
| GET /Snippets/Folders | Gets all snippet folders |
| POST /Snippets/Folder | Creates a new snippet folder |
| GET /Snippets/:id/Download | Download a specified snippet as a Word doc (.docx) file |
| PUT /Snippets/:id | Updates a specified snippet |
| DELETE /Snippets/:id | Deletes a specified snippet |
| PUT /Snippets/Folders/:id | Updates a specified snippet folder |
| DELETE /Snippets/Folders/:id | Deletes a specified empty snippet folder |
States
States are the available country states for localisation purposes
| Resource | Description |
|---|---|
| GET /States | Gets all states |
Submissions
Submissions are completed forms, often with generated documents
| Resource | Description |
|---|---|
| GET /Submissions | Search for a submission using query parameters |
| POST /Submissions | Creates a new submission |
| GET /Submissions/:id | Returns a specified submission |
| PUT /Submissions/:id/UpdateAnswer/:fieldRef | Update answers for a specified field in a specified submission |
| PUT /Submissions/:id/Submit | Submits a specified submission and queues it for document generation, if a template exists |
| DELETE /Submissions/:id/:permanently | Deletes a specified submission |
Template Styles
Template Styles are overrides for a form's document templates styles, where fonts, sizes and colours can be replaced
| Resource | Description |
|---|---|
| GET /TemplateStyles/:id | Returns a specified template style |
| PUT /TemplateStyles/:id | Updates a specified template style |
| DELETE /TemplateStyles/:id | Delets a specifed template style |
| GET /TemplateStyles | Search for template styles using query parameters |
| POST /TemplateStyles | Creates a new template style |
| GET /TemplateStyles/CustomFonts/:id | Returns a specified custom font |
| PUT /TemplateStyles/CustomFonts/:id | Updates a specified custom font |
| DELETE /TemplateStyles/CustomFonts/:id | Delets a specifed custom font |
| GET /TemplateStyles/CustomFonts | Search for custom fonts using query parameters |
| POST /TemplateStyles/CustomFonts | Upload a new custom font |