All Resources

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

Contacts are used to send forms to users, and can be synced between integrations and Smarter Drafter

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 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 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 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 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

Named Ranges are used in automations to insert conditional content

Resource	Description
GET /NamedRanges/:id	Returns a specified named range
PUT /NamedRanges/:id	Updates a specified named range
DELETE /NamedRanges/:id	Deletes a specified named range
GET /NamedRanges	Search for named ranges using query parameters
POST /NamedRanges	Creates a new named range

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	Get all replacement rules using a query parameter
POST /ReplacementRules	Creates a new replacement rule

States are the available country states for localisation purposes

Resource	Description
GET /States	Gets all states

Submissions are completed forms, often with generated documents

Resource	Description
POST /Submissions/Create	Creates a new Submission