For the complete documentation index, see llms.txt. This page is also available as Markdown.

Conversation organizations

Lists all organizations for a chatbot

get

Required Permission: chatbots.organizations.list

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

Query parameters
pageTokenstringOptional

The date after which to filter organizations. Only organizations created before this date will be fetched.

Example: 2024-09-29T07:08:00Z
limitnumberOptional

The amount of contacts to fetch

Responses
get
/v1/chatbots/{chatbotId}/organizations

Creates a new organization

post

Required Permission: chatbots.organizations.create

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

Body
namestringRequired

The name of the organization.

Example: Neue Firma GmbH
emailstringOptional

The email address of the organization.

Example: info@neue-firma.de
websitestringOptional

The website URL of the organization.

Example: https://neue-firma.de
sizenumberOptional

The number of employees in the organization.

Example: 10
industrystringOptional

The industry of the organization.

Example: E-Commerce
phoneNumberstringOptional

The phone number of the organization.

Example: +4915198765432
Responses
201Success
application/json
errorstringOptional

Optional error message.

post
/v1/chatbots/{chatbotId}/organizations
get

Required Permission: chatbots.organizations.list

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

Query parameters
querystringRequired

The search term.

pagenumberRequired

The page on which to start the seach.

Example: 1
pageSizenumberRequired

The number of pages to return.

Example: 250
hiddenHitsstringOptional

Comma-separated list of IDs to be excluded from the search results.

Responses
get
/v1/chatbots/{chatbotId}/organizations/search

Lists all contacts of an organization

get

Required Permission: chatbots.organizations.contacts.list

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

organizationIdstringRequired

The Id of the organization to add a contact to.

Responses
get
/v1/chatbots/{chatbotId}/organizations/{organizationId}/contacts

Retrieves a specific organization

get

Required Permission: chatbots.organizations.get

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

organizationIdstringRequired

The Id of the organization to add a contact to.

Responses
get
/v1/chatbots/{chatbotId}/organizations/{organizationId}

Deletes an organization

delete

Required Permission: chatbots.organizations.delete

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

organizationIdstringRequired

The Id of the organization to add a contact to.

Responses
delete
/v1/chatbots/{chatbotId}/organizations/{organizationId}

Updates an existing organization

patch

Required Permission: chatbots.organizations.edit

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

organizationIdstringRequired

The Id of the organization to add a contact to.

Body
Responses
patch
/v1/chatbots/{chatbotId}/organizations/{organizationId}

Gets the count of contacts in an organization

get

Required Permission: chatbots.organizations.contacts.list

Resource: chatbots/:chatbotId

Authorizations
x-chatcaptain-keystringRequired
Path parameters
chatbotIdstringRequired

The ID of the chatbot.

organizationIdstringRequired

The Id of the organization to add a contact to.

Responses
get
/v1/chatbots/{chatbotId}/organizations/{organizationId}/contacts/count

Last updated