Actions (54)
Conversations · 25
- Create Chat ThreadPOST /v2/conversations/{conversationId}/chats
Create a chat thread in a conversation.
documented - Create ConversationPOST /v2/conversations
Create a new conversation in an inbox with at least one thread.
documented - Create Customer ThreadPOST /v2/conversations/{conversationId}/customer
Create a customer thread in a conversation.
documented - Create NotePOST /v2/conversations/{conversationId}/notes
Create a note thread in a conversation.
documented - Create Phone ThreadPOST /v2/conversations/{conversationId}/phones
Create a phone thread in a conversation.
documented - Create Reply ThreadPOST /v2/conversations/{conversationId}/reply
Create a reply thread in a conversation.
documented - Delete AttachmentDELETE /v2/conversations/{conversationId}/attachments/{attachmentId}
Delete an attachment from a conversation.
documented - Delete ConversationDELETE /v2/conversations/{conversationId}
Delete a conversation by its ID.
documented - Delete SnoozeDELETE /v2/conversations/{conversationId}/snooze
Unsnooze the conversation.
documented - Delete Thread ScheduleDELETE /v2/conversations/{conversationId}/threads/{threadId}/schedule
Remove a scheduled thread.
documented - Download Attachment FileGET /v2/conversations/{conversationId}/attachments/{attachmentId}/file
Download an attachment file.
documented - Get Attachment DataGET /v2/conversations/{conversationId}/attachments/{attachmentId}/data
Return the raw data payload of an attachment (base64-encoded).
documented - Get ConversationGET /v2/conversations/{conversationId}
Retrieve a single conversation by its ID.
documented - Get Thread Original SourceGET /v2/conversations/{conversationId}/threads/{threadId}/original-source
Fetch the original source for a thread.
documented - Get Thread Original Source (RFC 822)GET /v2/conversations/{conversationId}/threads/{threadId}/original-source
Fetch the original RFC822 source of a thread (RFC 822 format).
documented - List ConversationsGET /v2/conversations
List and filter conversations (with support for embed of threads).
documented - List ThreadsGET /v2/conversations/{conversationId}/threads
List threads for a given conversation.
documented - Publish Thread SchedulePATCH /v2/conversations/{conversationId}/threads/{threadId}/schedule
Publish a previously scheduled thread.
documented - Update Custom FieldsPUT /v2/conversations/{conversationId}/fields
Update a conversation's custom fields (entire list replaced).
documented - Update SnoozePUT /v2/conversations/{conversationId}/snooze
Snooze a conversation (or modify snooze settings).
documented - Update TagsPUT /v2/conversations/{conversationId}/tags
Update tags on a conversation.
documented - Update ThreadPATCH /v2/conversations/{conversationId}/threads/{threadId}
Update a thread using JSON Patch semantics.
documented - Update Thread SchedulePUT /v2/conversations/{conversationId}/threads/{threadId}/schedule
Schedule or reschedule a thread to be sent later.
documented - Upload AttachmentPOST /v2/conversations/{conversationId}/threads/{threadId}/attachments
Upload an attachment to a thread.
documented - Upload Thread AttachmentPOST /v2/conversations/{conversationId}/attachments
Attach a file to a thread (thread must exist).
documented
Sites · 7
- Create SitePOST /v1/sites
Create a site.
documented - Delete SiteDELETE /v1/sites/{siteId}
Delete a site.
documented - Get SiteGET /v1/sites/{siteId}
Get a single site.
documented - Get Site RestrictionsGET /v1/sites/{siteId}/restrictions
Get site restrictions.
documented - List SitesGET /v1/sites
List Docs sites.
documented - Update SitePUT /v1/sites/{siteId}
Update a site.
documented - Update Site RestrictionsPUT /v1/sites/{siteId}/restrictions
Update site restrictions.
documented
Articles · 6
- Create ArticlePOST /v1/articles
Create a new article.
documented - Delete ArticleDELETE /v1/articles/{articleId}
Delete an article.
documented - Get ArticleGET /v1/articles/{articleId}
Retrieve a single article.
documented - List ArticlesGET /v1/articles
List articles for a Docs site.
documented - Search ArticlesGET /v1/articles/search
Search articles by query.
documented - Update ArticlePUT /v1/articles/{articleId}
Update an existing article.
documented
Categories · 6
- Create CategoryPOST /v1/categories
Create a new category.
documented - Delete CategoryDELETE /v1/categories/{categoryId}
Delete a category.
documented - Get CategoryGET /v1/categories/{categoryId}
Get a single category.
documented - List CategoriesGET /v1/categories
List all categories.
documented - Update CategoryPUT /v1/categories/{categoryId}
Update a category.
documented - Update Category OrderPUT /v1/categories/{categoryId}/order
Reorder categories.
documented
Collections · 5
- Create CollectionPOST /v1/collections
Create a collection.
documented - Delete CollectionDELETE /v1/collections/{collectionId}
Delete a collection.
documented - Get CollectionGET /v1/collections/{collectionId}
Get a collection.
documented - List CollectionsGET /v1/collections
List all collections.
documented - Update CollectionPUT /v1/collections/{collectionId}
Update a collection.
documented