Path Parameters
Body
application/json · object[]
Introduction
Tasks
- GETGet a resource with the provided ID
- PUTUpdate the given instance
- DELDelete the resource with the provided ID
- PUTUpdate the status of the task
- DELRemove the task status
- PUTUpdate the assignee of the task
- DELRemove the task assignee
- GETGet the entity metadata for the filter
- POSTCreate a new instance of the resource
- POSTCreate a new task with the given request (to include document families)
Projects
- GETGet a resource with the provided ID
- PUTUpdate the given instance
- DELDelete the project with the provided ID and its associated resources
- GETGet the tags on a project
- PUTUpdate the tags on a project
- GETGet the project resources
- PUTUpdate all the resources associated with this project
- GETPaginated list of assistants that have been added to this project
- PUTUpdate the assistant in the given project
- POSTCreate and add assistant to project
- PUTUpdate the assistant in the given project
- DELDelete specified assistant
- GETList the assistant stores specified assistant
- PUTUpdate the list of stores for an assistant
- PUTSend a schedule event now to this assistant
- PUTDeactivate the assistant (stopping it from getting content events)
- PUTActivate the assistant (ensuring it gets content events)
- GETGet a list of the data forms associated with this project
- POSTAdd a dataform to the project
- POSTSend a document to upload and send as an event to an assistant
- GETGet the task tags for the project
- GETGet the notes for the project
- GETGet a list of the stores (type data) associated with this project
- GETCreate a project template request
- GETPaginated list of assistant executions
- GETGet event handler options for an assistant
DocumentFamilies
- Document Families Overview
- GETGet a resource with the provided ID
- PUTUpdate the given instance
- DELDelete the resource with the provided ID
- GETGet the external data for a document family
- PUTUpdate the external data for a document family
- GETGet the entity metadata for the filter
- POSTCreate a new instance of the resource
- GETTouching a document family triggers a DocumentFamilyEvent without changing the document family
Taxonomies
Stores
Organizations
Executions
Data Forms
- GETGet data form by slug
- PUTUpdate data form
- DELDelete data form
- GETList data forms for organization
- POSTCreate new data form
- GETList all data forms
- GETGet a resource with the provided ID
- PUTUpdate the given instance
- DELDelete the resource with the provided ID
- GETGet the entity metadata for the filter
- POSTCreate a new instance of the resource
cURL
Copy
Ask AI
curl --request PUT \
--url http://localhost/api/projects/{id}/tags \
--header 'Content-Type: application/json' \
--data '[
{
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"organization": {
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"name": "<string>",
"slug": "<string>",
"publicAccess": true,
"description": "<string>",
"organizationStatus": "ACTIVE",
"hasImage": true,
"defaultToPrivateTemplates": true,
"connectServerUrl": "<string>",
"connectServerAccessToken": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"stripeCustomerId": "<string>",
"enterpriseOrganization": true,
"id": "<string>"
},
"name": "<string>",
"color": "<string>",
"id": "<string>"
}
]'Copy
Ask AI
[
{
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"organization": {
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"name": "<string>",
"slug": "<string>",
"publicAccess": true,
"description": "<string>",
"organizationStatus": "ACTIVE",
"hasImage": true,
"defaultToPrivateTemplates": true,
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"stripeCustomerId": "<string>",
"enterpriseOrganization": true,
"id": "<string>"
},
"name": "<string>",
"color": "<string>",
"id": "<string>"
}
]Projects
Update the tags on a project
Update the tags on a project
PUT
/
api
/
projects
/
{id}
/
tags
cURL
Copy
Ask AI
curl --request PUT \
--url http://localhost/api/projects/{id}/tags \
--header 'Content-Type: application/json' \
--data '[
{
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"organization": {
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"name": "<string>",
"slug": "<string>",
"publicAccess": true,
"description": "<string>",
"organizationStatus": "ACTIVE",
"hasImage": true,
"defaultToPrivateTemplates": true,
"connectServerUrl": "<string>",
"connectServerAccessToken": "<string>",
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"stripeCustomerId": "<string>",
"enterpriseOrganization": true,
"id": "<string>"
},
"name": "<string>",
"color": "<string>",
"id": "<string>"
}
]'Copy
Ask AI
[
{
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"organization": {
"uuid": "<string>",
"createdOn": "2023-11-07T05:31:56Z",
"updatedOn": "2023-11-07T05:31:56Z",
"changeSequence": 123,
"name": "<string>",
"slug": "<string>",
"publicAccess": true,
"description": "<string>",
"organizationStatus": "ACTIVE",
"hasImage": true,
"defaultToPrivateTemplates": true,
"supportAccess": true,
"supportAccessExpiresAt": "2023-11-07T05:31:56Z",
"stripeCustomerId": "<string>",
"enterpriseOrganization": true,
"id": "<string>"
},
"name": "<string>",
"color": "<string>",
"id": "<string>"
}
]⌘I