attach_company_members
ChatGPTAttach customers who have no company. Already-membered ids are skipped (not moved). Missing or other-organization ids are not_found. The 200 accounts for every requested id exactly once. No customer objects are returned.
create_article
ChatGPTCreate a knowledge base article. Draft content may be empty or omitted; published and archived articles require non-whitespace content.
create_business_hours_exception
ChatGPTAdd one date. Leave opens_at and closes_at empty for a closed day, or set both for one custom range (overnight allowed). Times are HH:MM or HH:MM:SS, not the weekly_hours weekday map. Save business hours before adding exceptions.
create_collection
ChatGPTCreate a knowledge base collection.
create_company
ChatGPTCreate a company. default_assignee_id must be an active organization member. Inbox access is checked later, when a new ticket is created.
create_customer
ChatGPTCreate a requester (customer) in the organization.
create_pending_attachment
ChatGPTMultipart upload (file_upload) before ticket creation. Pass the returned id in ticket create attachment_ids to claim the file. See the Tickets tag for the full upload flow.
create_ticket
ChatGPTCreate a ticket. Optional inbox_id targets a specific inbox; when omitted, the ticket routes to the organization's default inbox (is_default: true). Optional assignee_id sets the assignee on create (session and integration tokens). When omitted, the requester's company default assignee is used if that associate can access the inbox. Use created_by_role to choose associate-on-behalf (agent logs a ticket for a requester; always emails the customer) versus customer self-service (requester opens their own ticket; emails only when inbox auto-reply is enabled). When CC email routing is enabled, optional external_recipient_emails sets CC recipients for the new ticket: omit or send null for none; send a list (empty or not) to set recipients. The requester (from_email) is always included in that list. Optional attachment_ids claims files previously uploaded via POST .../pending-attachments/ (see Tickets tag for the upload flow).
create_ticket_attachment
ChatGPTMultipart upload (file_upload) for an existing ticket. Pass the returned id in message create attachment_ids to claim the file. See the Tickets tag for the full upload flow.
create_ticket_message
ChatGPTAdd a reply or internal note to the ticket. For customer-visible replies, optional external_recipient_emails sets CC recipients for that message; omit or null to reuse CC recipients from the previous customer-visible message or from ticket creation. Internal notes ignore this field. Optional attachment_ids claims files previously uploaded via POST .../tickets/{ticket_id}/attachments/ (see Tickets tag for the upload flow). A channel may reject a customer-visible reply with 400 {detail, code}. WhatsApp uses whatsapp_window_closed when the customer service window is closed.
delete_article
ChatGPTDelete an article. Address the article by ID or slug.
delete_business_hours
ChatGPTRemove the schedule. The organization is open 24/7 afterward.
delete_business_hours_exception
ChatGPTUse this to permanently delete one business-hours date exception by its id. The weekly schedule is left unchanged, and that date falls back to the weekly hours. This cannot be undone.
delete_collection
ChatGPTDelete a collection.
delete_company
ChatGPTHard-delete the company. Members become ungrouped (company_id null). Tickets stay on the person and keep their assignee.
list_articles
ChatGPTReturn knowledge base articles for the organization. Filter by collection or publication status with query parameters.
list_business_hours_exceptions
ChatGPTPaginated date exceptions for the organization's schedule. Optional from and to limit the list to that inclusive date range.
list_collection_tree
ChatGPTReturn collections as a nested tree. Use include_articles to embed articles per collection node.
list_collections
ChatGPTReturn knowledge base collections for the organization's portal.
list_companies
ChatGPTReturn companies for the organization. Filter by name with search (accent-insensitive) or by an exact claimed domain with domain. Each row includes member_count.
list_custom_preset_filters
ChatGPTReturn saved ticket search filters visible to the caller. Integration tokens receive organization-shared filters only.
list_customers
ChatGPTReturn requesters (customers) for the organization. Filter members of a company with company=<uuid>, or ungrouped people with company=ungrouped.
list_inboxes
ChatGPTReturn all inboxes for the organization. On ticket create, inbox_id is optional: omit to route to the default inbox (is_default: true), or provide an inbox ID from this list to target a specific mailbox. The email channel connection's external_identifier is the branded support address when that identity is enabled and ready, and the hosted initdesk address otherwise.
list_organizations
ChatGPTList organizations the authenticated user belongs to. Use the organization ID in subsequent API paths. Filter by name with search.
list_tags
ChatGPTReturn all tags defined for the organization, including id, name, color, and instructions.
list_ticket_messages
ChatGPTReturn messages for a ticket.
list_ticket_statuses
ChatGPTReturn all ticket status values with human-readable labels (enum value and description per entry).
list_tickets
ChatGPTReturn tickets for the organization. By default only non-spam tickets are included; pass is_spam=true to list spam tickets. Filter by requester with customer_id. Filter by the requester's current company with company (UUID). There is no company=ungrouped ticket filter in v1.
partial_update_article
ChatGPTUpdate selected article fields. Address the article by ID or slug. Omitted content is preserved. The final status and content must allow empty content only for drafts.
partial_update_business_hours_exception
ChatGPTUse this to change selected fields on one business-hours date exception. Values you send replace what is stored, including clearing an open or close time. The previous value of a field you send is not kept. Fields you omit stay as they are. Use update_business_hours_exception to replace the whole exception, or delete_business_hours_exception to remove it.
partial_update_collection
ChatGPTUpdate selected collection fields.
partial_update_company
ChatGPTUpdate selected company fields.
partial_update_customer
ChatGPTUpdate selected requester fields. Set company_id to group the person, or null to ungroup. This write allows moving someone who already has a company. Changing company_id clears is_company_manager. Setting is_company_manager true requires a current company.
partial_update_portal_settings
ChatGPTPartially update portal settings for the organization.
ping
ChatGPTReturn pong. Use this to verify Gemini Spark can execute tools/call.
retrieve_article
ChatGPTReturn an article by ID or slug.
retrieve_business_hours
ChatGPTOne schedule for the organization. timezone is an IANA name such as America/Sao_Paulo. weekly_hours is an object whose keys are mon, tue, wed, thu, fri, sat, and sun. Each value is null when that day is closed, or one range {"opens_at": "09:00", "closes_at": "18:00"}. Times are 24-hour HH:MM with no seconds (not HH:MM:SS). The opening minute is inside the range. A close earlier than the open continues overnight. Omitted weekdays are stored as closed. A list of ranges is rejected. Date exceptions are a separate list. No saved schedule means open 24/7 and weekly_hours is {}. is_open_now, next_open (ISO UTC), and next_open_display (organization working language) are read-only.
retrieve_business_hours_exception
ChatGPTUse this to read one business-hours date exception by its id. Returns the calendar date, label, yearly-repeat flag, and open/close times. Both times null means that date is closed. Does not create, change, or delete the exception.
retrieve_collection
ChatGPTReturn a collection by ID.
retrieve_company
ChatGPTReturn a company by ID.
retrieve_custom_preset_filter
ChatGPTReturn a saved ticket search filter by ID. Integration tokens may only retrieve organization-shared filters.
retrieve_customer
ChatGPTReturn a requester by ID.
retrieve_inbox
ChatGPTReturn inbox details, including email prefix and whether it is the default inbox for the organization. The email channel connection's external_identifier is the branded support address when that identity is enabled and ready, and the hosted initdesk address otherwise.
retrieve_organization
ChatGPTRetrieve an organization by its internal ID or public_id.
retrieve_portal_favicon_url
ChatGPTRetrieve the portal favicon URL for the given size (pixels).
retrieve_portal_logo_url
ChatGPTRetrieve the portal logo URL for the given size. Use a number for a square image (e.g. 128), or a number with 'h'/'w' suffix to constrain height or width while preserving aspect ratio (e.g. 100h or 100w).
retrieve_portal_settings
ChatGPTUse this to read the organization's support portal settings, including name, theme, and whether the portal is active. If no portal record exists yet, this call creates one and then returns it. It does not edit an existing portal, delete settings, or send messages.
retrieve_tag
ChatGPTReturn a single organization tag by ID, including id, name, color, and instructions.
retrieve_ticket
ChatGPTReturn full ticket details for the given ticket ID. To retrieve its messages (replies and internal notes), use the messages endpoint.
retrieve_ticket_attachment
ChatGPTRedirects to the attachment file URL in storage (HTTP redirect response).
retrieve_ticket_message_raw_content
ChatGPTReturn the provider-complete text of an inbound message when it differs from the message content shown on the timeline. Used for see-entire-message. Returns 404 when no message raw content exists.
search_articles
ChatGPTSearch articles by title, excerpt, and markdown content. Results are limited by the limit query parameter.
search_tickets
ChatGPTSearch tickets in the organization.
unassign_ticket
ChatGPTRemoves the current assignee from the ticket (sets assignee to null) and returns updated ticket details.
update_article
ChatGPTReplace article fields (full update). Address the article by ID or slug. Omitted content is preserved. Empty content is allowed only for drafts.
update_business_hours
ChatGPTOne schedule for the organization. timezone is an IANA name such as America/Sao_Paulo. weekly_hours is an object whose keys are mon, tue, wed, thu, fri, sat, and sun. Each value is null when that day is closed, or one range {"opens_at": "09:00", "closes_at": "18:00"}. Times are 24-hour HH:MM with no seconds (not HH:MM:SS). The opening minute is inside the range. A close earlier than the open continues overnight. Omitted weekdays are stored as closed. A list of ranges is rejected. Date exceptions are a separate list. No saved schedule means open 24/7 and weekly_hours is {}. is_open_now, next_open (ISO UTC), and next_open_display (organization working language) are read-only. PUT null or an empty object removes the schedule, same as DELETE.
update_business_hours_exception
ChatGPTUse this to replace one business-hours date exception. Send the full date, label, repeat flag, and open/close times; this overwrites the saved exception. Leave both times empty for a closed day, or set both for one custom range (an earlier close continues overnight). Times are HH:MM or HH:MM:SS. Use partial_update_business_hours_exception to change only some fields.
update_collection
ChatGPTReplace collection fields (full update).
update_company
ChatGPTReplace company fields (full update).
update_customer
ChatGPTReplace requester fields (full update).
update_portal_settings
ChatGPTReplace all portal settings for the organization (full update).
attach_company_members
Claudecreate_article
Claudecreate_business_hours_exception
Claudecreate_collection
Claudecreate_company
Claudecreate_customer
Claudecreate_pending_attachment
Claudecreate_ticket
Claudecreate_ticket_attachment
Claudecreate_ticket_message
Claudedelete_article
Claudedelete_business_hours
Claudedelete_business_hours_exception
Claudedelete_collection
Claudedelete_company
Claudelist_articles
Claudelist_business_hours_exceptions
Claudelist_collection_tree
Claudelist_collections
Claudelist_companies
Claudelist_custom_preset_filters
Claudelist_customers
Claudelist_inboxes
Claudelist_organizations
Claudelist_tags
Claudelist_ticket_messages
Claudelist_ticket_statuses
Claudelist_tickets
Claudepartial_update_article
Claudepartial_update_business_hours_exception
Claudepartial_update_collection
Claudepartial_update_company
Claudepartial_update_customer
Claudepartial_update_portal_settings
Claudeping
Clauderetrieve_article
Clauderetrieve_business_hours
Clauderetrieve_business_hours_exception
Clauderetrieve_collection
Clauderetrieve_company
Clauderetrieve_custom_preset_filter
Clauderetrieve_customer
Clauderetrieve_inbox
Clauderetrieve_organization
Clauderetrieve_portal_favicon_url
Clauderetrieve_portal_logo_url
Clauderetrieve_portal_settings
Clauderetrieve_tag
Clauderetrieve_ticket
Clauderetrieve_ticket_attachment
Clauderetrieve_ticket_message_raw_content
Claudesearch_articles
Claudesearch_tickets
Claudeunassign_ticket
Claudeupdate_article
Claudeupdate_business_hours
Claudeupdate_business_hours_exception
Claudeupdate_collection
Claudeupdate_company
Claudeupdate_customer
Claudeupdate_portal_settings
Claude