Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
Moon (Dark Mode)
Sun (Light Mode)
v1.0
API Reference
Add a new PMS field map.
Search
All
Pages
Start typing to search…
JUMP TO
Smarter Drafter API
Overview
Authentication
Versioning
Error Codes
All Resources
Aliases
Search for aliases based on the query parameters.
get
Add a new alias.
post
Get an alias by ID.
get
Update an alias by ID.
put
Delete an alias by ID.
delete
Api Keys
List all api keys for the current user. Admins can see all keys.
get
Creates a new Api Key.
post
Update Api Key name by ID.
put
Reactivate Api Key by ID.
put
Deactivate Api Key by ID.
put
Contacts
Gets a contact by ID.
get
Updates an existing contact.
put
Deletes a contact.
delete
Searches for contacts.
get
Adds a new contact.
post
Search for contacts based on query parameters.
get
Fields
Search for fields based on query parameters.
get
Add a new field.
post
Update an existing field.
put
Delete a field.
delete
Folders
Gets the library of client folders.
get
Adds a new folder.
post
Updates a folder.
put
Deletes a folder.
delete
FormRoles
Get a form role by ID.
get
Update a form role by ID.
put
Delete a form role by ID.
delete
Search for form roles based on query parameters.
get
Add a new form role.
post
Forms
Retrieves a form by ID.
get
Updates an existing form.
put
Searches for forms based on the provided filter and pagination parameters.
get
Adds a new form.
post
Deletes a form.
delete
Retrieves fields by form ID.
get
Retrieves field overwrites associated with a child form.
get
Retrieves field maps associated with a form.
get
Adds a new child form.
post
Overwrites a field in a form.
put
Deletes a field overwrite in a form.
delete
Overwrites fields in a section.
put
Saves field maps associated with a form.
put
FormTemplates
Gets the form template with the specified ID.
get
Updates the form template with the specified ID.
put
Deletes the form template with the specified ID.
delete
Downloads the form template with the specified ID.
get
Searches for form templates based on the specified query parameters.
get
Adds a new form template.
post
Option Set
Get an option set by ID.
get
Update an option set by ID.
put
Delete an option set by ID.
delete
Search for option sets based on the specified query parameters.
get
Add a new option set.
post
PMS Field Map
Get a PMS field map by ID.
get
Update a PMS field map by ID.
put
Delete a PMS field map by ID.
delete
Search for PMS field maps based on query parameters.
get
Add a new PMS field map.
post
NamedRanges
Gets a named range by ID.
get
Updates an existing named range.
put
Deletes a named range.
delete
Searches for named ranges based on the specified query parameters.
get
Adds a new named range.
post
ReplacementRules
Gets a replacement rule by ID.
get
Updates an existing replacement rule.
put
Deletes a replacement rule.
delete
Gets all default replacement rules.
get
Searches for replacement rules based on the specified query parameters.
get
Adds a new replacement rule.
post
Snippets
Searches for snippets based on the provided filter and pagination parameters.
get
Adds a new snippet.
post
Get all snippet folders.
get
Creates a new snippet folder.
post
Download a snippet as a Word document.
get
Update snippet by ID.
put
Delete a snippet by ID.
delete
Update snippet folder.
put
Delete an empty snippet folder by ID.
delete
States
Get the list of country states.
get
Submissions
Creates a new submission.
post
Retrieves a submission by its GUID.
get
Searches for submissions based on the provided query parameters.
get
Deletes a submission by its GUID.
delete
Template Styles
Get a template style by ID.
get
Update a template style by ID.
put
Delete a template style by ID.
delete
Search for template styles based on the query parameters.
get
Add a new template style.
post
/v1/clients/TemplateStyles/CustomFonts/{id}
get
/v1/clients/TemplateStyles/CustomFonts/{id}
put
/v1/clients/TemplateStyles/CustomFonts/{id}
delete
/v1/clients/TemplateStyles/CustomFonts
get
/v1/clients/TemplateStyles/CustomFonts
post
Powered by
Add a new PMS field map.
post
https://{server}/v1/clients/PmsFieldMap
Language
Shell
Node
Ruby
PHP
Python
Credentials
Header
Header
URL
Base URL
https://
server
/v1/clients/PmsFieldMap
RESPONSE
Click
Try It!
to start a request and see the response here!