JobManager
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets job log entries for specified ID. |
Gets job log entries for specified ID. |
| DELETE Cancels existing job by the specified ID. |
Cancels existing job by the specified ID. |
| GET |
No documentation available. |
LoanAffiliates
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of loan affiliates |
Gets list of loan affiliates |
| GET Gets an existing loan affiliate by ID |
Gets an existing loan affiliate by ID |
| POST Adds a new loan affiliate |
Adds a new loan affiliate |
| PATCH Updates an existing loan affiliate |
Updates an existing loan affiliate |
| DELETE Deletes an existing loan affiliate by ID |
Deletes an existing loan affiliate by ID |
| POST Imports a list of loan affiliates from CSV |
Imports a list of loan affiliates from CSV |
| GET |
No documentation available. |
Partners
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of partners |
Gets list of partners |
| GET Gets an existing partner by ID |
Gets an existing partner by ID |
| POST Adds a new partner |
Adds a new partner |
| PATCH Updates an existing partner |
Updates an existing partner |
| DELETE Deletes an existing partner by ID |
Deletes an existing partner by ID |
| POST Imports a list of partners from CSV |
Imports a list of partners from CSV |
| GET Gets list of partners |
Gets list of partners |
| GET |
No documentation available. |
MarketingFeatures
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of marketing features |
Gets list of marketing features |
| GET Gets an existing marketing feature by ID |
Gets an existing marketing feature by ID |
| POST Adds a new marketing feature |
Adds a new marketing feature |
| PATCH Updates an existing marketing feature |
Updates an existing marketing feature |
| DELETE Deletes an existing marketing feature by ID |
Deletes an existing marketing feature by ID |
| POST Imports marketing features from CSV format |
Imports marketing features from CSV format |
| GET Exports list of marketing features in CSV format |
Exports list of marketing features in CSV format |
| GET Gets list of products for marketing feature |
Gets list of products for marketing feature |
| GET |
No documentation available. |
Businesses
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of businesses |
Gets list of businesses |
| GET Gets an existing business by ID |
Gets an existing business by ID |
| POST Adds a new business |
Adds a new business |
| PATCH Updates an existing business |
Updates an existing business |
| DELETE Deletes an existing business by ID |
Deletes an existing business by ID |
| POST Deletes an existing business by ID |
Deletes an existing business by ID |
| GET Gets a list of corp admins. |
Gets a list of corp admins. |
| POST Allows an admin to create a corp admin |
Allows an admin to create a corp admin |
| GET Gets a list of information related to a business. |
Gets a list of information related to a business. |
| POST Gets a list of information related to a business. |
Gets a list of information related to a business. |
| GET Gets list of subscribers for a business |
Gets list of subscribers for a business |
| GET |
No documentation available. |
CoContact
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of CoContacts |
Gets list of CoContacts |
| GET Gets an existing CoContact by ID |
Gets an existing CoContact by ID |
| GET |
No documentation available. |
AutoCampaigns
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of auto-campaigns |
Gets list of auto-campaigns |
| GET Gets an existing auto-campaign by ID |
Gets an existing auto-campaign by ID |
| POST Adds a new auto-campaign |
Adds a new auto-campaign |
| PATCH Updates an existing auto-campaign |
Updates an existing auto-campaign |
| DELETE Deletes an existing auto-campaign by ID |
Deletes an existing auto-campaign by ID |
| POST |
No documentation available. |
| POST |
No documentation available. |
| GET Gets command packet for an existing auto-campaign |
Gets command packet for an existing auto-campaign |
| GET Gets command packet for an existing auto-campaign |
Gets command packet for an existing auto-campaign |
| GET Gets tokenized HTML for an existing auto-campaign using VFS |
Gets tokenized HTML for an existing auto-campaign using VFS |
| GET Gets tokenized HTML for an existing auto-campaign using VFS |
Gets tokenized HTML for an existing auto-campaign using VFS |
| POST Sends |
Sends |
| GET Gets rendered output for an existing auto-campaign using VFS |
Gets rendered output for an existing auto-campaign using VFS |
| GET Gets rendered output for an existing auto-campaign using VFS |
Gets rendered output for an existing auto-campaign using VFS |
| GET Gets list of auto-campaign categories available to the current user |
Gets list of auto-campaign categories available to the current user |
| GET Gets list of auto-campaign categories available to the current user |
Gets list of auto-campaign categories available to the current user |
| GET Gets rendered output for an existing auto-campaign using VFS |
Gets rendered output for an existing auto-campaign using VFS |
| GET |
No documentation available. |
Contacts
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of contacts |
Gets list of contacts |
| GET Gets an existing contact by ID |
Gets an existing contact by ID |
| POST Adds a new contact |
Adds a new contact |
| PATCH Updates an existing contact |
Updates an existing contact |
| DELETE Deletes an existing contact by ID |
Deletes an existing contact by ID |
| POST Imports a list of contacts from CSV |
Imports a list of contacts from CSV |
| GET Gets contact types for specified contact. |
Gets contact types for specified contact. |
| POST Adds contact type to specified contact. |
Adds contact type to specified contact. |
| DELETE Adds contact type to specified contact. |
Adds contact type to specified contact. |
| POST Transfers a contact from one subscriber to another |
Transfers a contact from one subscriber to another |
| POST Transfers a contact from one subscriber to another |
Transfers a contact from one subscriber to another |
| POST Transfers list of contacts from one subscriber to another |
Transfers list of contacts from one subscriber to another |
| POST Adds contact to users suppression list |
Adds contact to users suppression list |
| POST Removes contact to users suppression list |
Removes contact to users suppression list |
| GET Gets a contacts most recent transfer |
Gets a contacts most recent transfer |
| GET Gets the list of contacts for a specific VFS job and recipient index. |
Gets the list of contacts for a specific VFS job and recipient index. |
| POST Unsubscribes a contact from a list of subscribers. |
Unsubscribes a contact from a list of subscribers. |
| GET |
No documentation available. |
VFSTemplates
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of VFS Templates |
Gets list of VFS Templates |
| GET Gets template by id |
Gets template by id |
| GET Gets template contents by id |
Gets template contents by id |
| GET |
No documentation available. |
Notes
v4 API Route to perform CRUD and Search operations on Notes.
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET List all notes that match the given filter criteria |
List all notes that match the given filter criteria |
| GET Retrieve a single note by ID |
Retrieve a single note by ID |
| POST Create a new note authored by the current user for the current team |
Create a new note authored by the current user for the current team |
| PATCH Updates an existing note |
Updates an existing note |
| DELETE Flag an existing note as deleted |
Flag an existing note as deleted |
| POST Imports a list of notes from CSV |
Imports a list of notes from CSV |
| GET Gets export of all notes that match the given filter criteria. |
Gets export of all notes that match the given filter criteria. |
| GET |
No documentation available. |
AuthToken
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of AuthTokens |
Gets list of AuthTokens |
| GET Gets an existing AuthTokens by ID |
Gets an existing AuthTokens by ID |
| DELETE Deletes an existing AuthTokens by ID |
Deletes an existing AuthTokens by ID |
| GET Gets export of all AuthTokens |
Gets export of all AuthTokens |
| GET |
No documentation available. |
DocLibraryV4
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of team members |
Gets list of team members |
| GET |
No documentation available. |
VFSProducts
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of VFS Products |
Gets list of VFS Products |
| GET Gets VFS Product by id |
Gets VFS Product by id |
| GET |
No documentation available. |
TeamMembers
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of team members |
Gets list of team members |
| GET Gets an existing team member by ID |
Gets an existing team member by ID |
| POST Adds a new team member |
Adds a new team member |
| DELETE Deletes an existing team member |
Deletes an existing team member |
| GET Gets list of possible team members to be added |
Gets list of possible team members to be added |
| GET |
No documentation available. |
Products
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of contact types |
Gets list of contact types |
| POST Creates a global contact type for a product |
Creates a global contact type for a product |
| PATCH Updates an existing Contact Type. |
Updates an existing Contact Type. |
| POST Reorders a list of contact types |
Reorders a list of contact types |
| GET |
No documentation available. |
AuthClient
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of AuthClients |
Gets list of AuthClients |
| GET Gets an existing AuthClient by ID |
Gets an existing AuthClient by ID |
| POST Adds a new AuthClient |
Adds a new AuthClient |
| PATCH Updates an existing AuthClient |
Updates an existing AuthClient |
| DELETE Deletes an existing AuthClient by ID |
Deletes an existing AuthClient by ID |
| GET |
No documentation available. |
Reminders
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of reminders |
Gets list of reminders |
| GET Gets an existing reminder by ID |
Gets an existing reminder by ID |
| POST Adds a new reminder |
Adds a new reminder |
| PATCH Updates an existing reminder |
Updates an existing reminder |
| DELETE Deletes an existing reminder by ID |
Deletes an existing reminder by ID |
| POST Imports a list of reminders from CSV |
Imports a list of reminders from CSV |
| POST Sends email notification to assignee for existing reminder |
Sends email notification to assignee for existing reminder |
| GET |
No documentation available. |
AutoCampaignSettings
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of auto-campaign settings |
Gets list of auto-campaign settings |
| GET Gets existing auto-campaign settings by ID |
Gets existing auto-campaign settings by ID |
| POST Adds new auto-campaign settings |
Adds new auto-campaign settings |
| PATCH Updates existing auto-campaign settings |
Updates existing auto-campaign settings |
| DELETE Deletes an existing auto-campaign settings by ID |
Deletes an existing auto-campaign settings by ID |
| GET |
No documentation available. |
MarketingProducts
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of marketing products |
Gets list of marketing products |
| GET Gets an existing marketing product by ID |
Gets an existing marketing product by ID |
| POST Adds a new marketing product |
Adds a new marketing product |
| PATCH Updates an existing marketing product |
Updates an existing marketing product |
| DELETE Deletes an existing marketing product by ID |
Deletes an existing marketing product by ID |
| POST Imports marketing products from CSV format |
Imports marketing products from CSV format |
| GET Exports list of marketing products in CSV format |
Exports list of marketing products in CSV format |
| GET Gets command packet for an existing marketing product |
Gets command packet for an existing marketing product |
| GET Gets command packet for an existing marketing product |
Gets command packet for an existing marketing product |
| GET Gets tokenized HTML for an existing marketing product using VFS |
Gets tokenized HTML for an existing marketing product using VFS |
| GET Gets tokenized HTML for an existing marketing product using VFS |
Gets tokenized HTML for an existing marketing product using VFS |
| GET Gets rendered output for an existing marketing product using VFS |
Gets rendered output for an existing marketing product using VFS |
| GET Gets rendered output for an existing marketing product using VFS |
Gets rendered output for an existing marketing product using VFS |
| GET |
No documentation available. |
Branch
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of branches |
Gets list of branches |
| GET Gets an existing branch by ID |
Gets an existing branch by ID |
| POST Adds a new branch |
Adds a new branch |
| PATCH Updates an existing branch |
Updates an existing branch |
| DELETE Deletes an existing branch by ID |
Deletes an existing branch by ID |
| GET |
No documentation available. |
Loans
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET Gets list of loans |
Gets list of loans |
| GET Gets an existing loan by ID |
Gets an existing loan by ID |
| POST Adds a new loan |
Adds a new loan |
| PATCH Updates an existing loan |
Updates an existing loan |
| DELETE Deletes an existing loan by ID |
Deletes an existing loan by ID |
| POST Imports a list of loans from CSV |
Imports a list of loans from CSV |
| GET Gets status of an existing loan import request. |
Gets status of an existing loan import request. |
| DELETE Cancels and existing loan import request. |
Cancels and existing loan import request. |
| GET |
No documentation available. |
VFSJobs
| API | Description |
|---|---|
| GET |
No documentation available. |
| GET |
No documentation available. |
| GET |
No documentation available. |
| GET |
No documentation available. |
| GET |
No documentation available. |
| GET |
No documentation available. |
| GET |
No documentation available. |
| GET |
No documentation available. |
| GET |
No documentation available. |
| GET |
No documentation available. |
| GET |
No documentation available. |
| GET |
No documentation available. |
| POST |
No documentation available. |
| GET |
No documentation available. |
| GET |
No documentation available. |
| GET |
No documentation available. |
| GET |
No documentation available. |
| GET |
No documentation available. |
| GET |
No documentation available. |
| POST |
No documentation available. |
| POST |
No documentation available. |
| POST |
No documentation available. |
| POST |
No documentation available. |
| POST |
No documentation available. |
| POST |
No documentation available. |
| POST |
No documentation available. |
| POST |
No documentation available. |