Superchat
API integration

list_all_superchat_users

List all users in Superchat workspace. Returns user fields including id, first_name, last_name, email, role, language, created_at, updated_at, and associated inboxes.

get_single_superchat_user_by_id

Get a specific user in Superchat. Requires id. Returns fields including id, first_name, last_name, email, role, language, created_at, updated_at, and inboxes the user has access to.

list_all_superchat_me

Get information about yourself as a Superchat user. Returns user.id, first_name, last_name, email, role, language, created_at, updated_at, inboxes, and workspace.name.

list_all_superchat_contacts

List all contacts in Superchat workspace. Returns an array of contact objects containing fields like id, first_name, last_name, gender, created_at, updated_at, handles, and custom_attributes. Results are sorted by created_at in descending order.

get_single_superchat_contact_by_id

Get a specific contact in Superchat using id. Returns id, first_name, last_name, gender, created_at, updated_at, handles, and custom_attributes for the contact.

create_a_superchat_contact

Create a new contact in Superchat using the required handles parameter. Returns the contact id, first_name, last_name, gender, created_at, updated_at, handles, and custom_attributes fields in the response.

update_a_superchat_contact_by_id

Update a contact in Superchat using id. Returns id, first_name, last_name, gender, created_at, updated_at, handles, and custom_attributes for the updated contact.

delete_a_superchat_contact_by_id

Delete a contact in Superchat using id. Returns the deleted contact's unique id in the response.

list_all_superchat_channels

List all channels in Superchat workspace. Returns an array of channel objects including id, name, type, inbox, and url. Results are sorted by created_at in descending order.

get_single_superchat_channel_by_id

Get a specific channel in Superchat by id. Returns fields such as id, name, type, inbox, and url for the channel.

list_all_superchat_conversations

List all conversations in Superchat. Returns an array of conversations with fields such as id, status, channel, contacts, assigned_users, labels, inbox, and time_window.

get_single_superchat_conversation_by_id

Get a conversation in Superchat using id. Returns id, url, channel details (type, id, url), status, snoozed_until, time_window, contacts, assigned_users, labels, and inbox details.

update_a_superchat_conversation_by_id

Update a conversation in Superchat using id. Returns id, status, channel details, assigned_users, labels, snoozed_until, time_window, contacts, and inbox details.

delete_a_superchat_conversation_by_id

Delete a conversation in Superchat using id. Returns the id of the deleted conversation confirming successful removal.

get_single_superchat_conversation_export_by_id

Get a conversation export in Superchat. Requires conversation_id and id. Returns id, start, end, link (url, valid_until), and status fields providing export details and a temporary download link.

create_a_superchat_conversation_export

Create a conversation export in Superchat. Requires conversation_id. Returns id, start, end, link (with url and valid_until), and status indicating the export job state.

list_all_superchat_custom_attributes

List all custom contact attributes in Superchat. Returns each attribute's id, name, resource, type, and specification for multi-select and single-select fields.

list_all_superchat_files

List all files in Superchat workspace. Returns an array of file objects sorted by created_at descendingly, including id, name, url, mime_type, and link with valid_until.

get_single_superchat_file_by_id

Get a file in Superchat using id. Returns file details including id, name, url, mime_type, and link (containing a temporary download url and valid_until timestamp).

delete_a_superchat_file_by_id

Delete a file in Superchat using the required id. Returns the id of the deleted file in the response.

create_a_superchat_file

Upload a new file to Superchat. Returns id (unique identifier), url (file API resource), name (file name), link.url (temporary download link), link.valid_until (link expiry time), and mime_type (file type). File size must not exceed 5MB.

list_all_superchat_inboxes

List all inboxes in Superchat. Returns fields including id, name, url, and users (each with id, email, and url).

get_single_superchat_inbox_by_id

Get a specific inbox in Superchat using id. Returns id, url, name, and users array with user id, url, and email for each user.

list_all_superchat_labels

List all labels in Superchat. Returns label id, name, and url for each conversation label available in the workspace.

get_single_superchat_label_by_id

Get a label in Superchat using id. Returns the label's id, name, and url fields representing the unique identifier, label name, and API resource URL respectively.

create_a_superchat_message

Send a message in Superchat using the specified channel (from) to a recipient (to). Returns id, url, created_at, updated_at, status, direction, to, from, content, in_reply_to, and conversation_id fields in the response.

list_all_superchat_notes

List all notes for a specific conversation in Superchat. Requires conversation_id. Returns id, content, created_at, updated_at, and author details for each note.

get_single_superchat_note_by_id

Get a specific note in Superchat using conversation_id and id. Returns note fields including id, content, created_at, updated_at, and author details (id, name, email, url).

create_a_superchat_note

Create a note in a specific conversation in Superchat. Requires conversation_id. Returns note id, url, created_at, updated_at, content, and author details including id, name, url, and email.

update_a_superchat_note_by_id

Update a note in Superchat for a specific conversation. Requires conversation_id and id. Returns the note's id, content, author details, and timestamps (created_at, updated_at).

delete_a_superchat_note_by_id

Delete a note in Superchat from a specific conversation using conversation_id and id. Returns the id of the deleted note in the response.

list_all_superchat_templates

List all templates in Superchat for a workspace. Returns an array of templates with fields such as id, name, status, content, created_at, updated_at, folder_id, and url.

get_single_superchat_template_by_id

Get a specific template in Superchat by id. Returns key fields including id, name, status, created_at, updated_at, folder_id, content, channels, and whats_app_business_account_id.

delete_a_superchat_template_by_id

Delete a template in Superchat using id. Returns the deleted template's id in the response.

create_a_superchat_template

Create a new template in Superchat workspace. Returns id, status, created_at, updated_at, folder_id, name, content details, channels, whats_app_business_account_id, and url in the response.

update_a_superchat_template_by_id

Update a template in Superchat using id. Updates the template name or moves it to a different folder. Returns id, status, name, folder_id, content, channels, created_at, and updated_at.

list_all_superchat_template_folders

List all template folders in Superchat. Returns each folder's id, name, and parent_id fields for identifying and organizing template folders.

create_a_superchat_template_folder

Create a template folder in Superchat. Requires name. Returns id, name, and parent_id of the created template folder.

update_a_superchat_template_folder_by_id

Update a specific template folder in Superchat using id. Returns id, name, and parent_id of the updated template folder.

delete_a_superchat_template_folder_by_id

Delete a specific template folder in Superchat. Requires id. Only empty folders can be deleted. Returns the id of the deleted folder in the response.

list_all_superchat_contact_lists

List all contact lists in Superchat. Returns a list of contact lists with fields id, name, and url for each contact list.

get_single_superchat_contact_list_by_id

Get a contact list in Superchat using id. Returns fields such as url (resource URL), id (contact list identifier), and name (contact list name).

list_all_superchat_search_contacts

Search contacts in Superchat by any field such as mail or phone using field, operator, and value. Returns contact objects with id, first_name, last_name, gender, handles, custom_attributes, created_at, and updated_at.

list_all_superchat_contact_conversations

Get all conversations for a specific contact in Superchat. Requires contact_id. Returns fields such as id, status, channel details, assigned_users, labels, and inbox information for each conversation.

list_all_superchat_contact_contact_lists

Get contact lists for a contact in Superchat. Requires contact_id. Returns each contact list with id (unique identifier), name (list name), and url (resource link).

get_single_superchat_contact_contact_list_by_id

Get a contact list for a contact in Superchat using contact_id and id. Returns fields url (resource URL), id (contact list identifier), and name (contact list name).

delete_a_superchat_contact_contact_list_by_id

Delete a contact from a specific contact list in Superchat. Requires contact_id and id. Returns the deleted contact list id upon success.

create_a_superchat_contact_contact_list

Add a contact to a single contact list in Superchat. Requires contact_id. Returns the contact list id, name, and url of the newly associated list.