Skip to main content
Respond.io logo
  • Category: customer support
  • Auth: API_KEY
  • Composio-managed OAuth available? N/A
  • Tools: 8
  • Triggers: 0
  • Slug: RESPOND_IO
  • Version: 20261101_00

Tools

Slug: RESPOND_IO_CREATE_COMMENTTool to add a comment (internal note) to a contact’s conversation. Use after verifying the contact identifier.

Input Parameters

string
required
Content of the comment (internal note), up to 1000 characters. You can mention other users using {{@user.ID}}.
string
required
Identifier of the contact; either ‘id:<contact_id>’, ‘email:<email>’ or ‘phone:<E.164_phone>’. Example: ‘id:123’, ‘email:abdc@gmail.com’, ‘phone:+60121233112’

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RESPOND_IO_CREATE_CONTACTCreates a new contact in the respond.io workspace with the specified details. The contact is identified by email, phone number, or contact ID. Supports adding profile information, language preferences, and custom fields that have been pre-configured in the workspace.

Input Parameters

string
Email address of the contact
string
Phone number of the contact including country code
string
ISO 639-1 two-letter language code (e.g., ‘en’ for English, ‘es’ for Spanish)
string
Last name of the contact
string
required
First name of the contact
string
required
Unique identifier for the contact in one of these formats: ‘email:<email_address>’ (e.g., ‘email:john@example.com’), ‘phone:<phone_number>’ (e.g., ‘phone:+60121233112’ with country code), or an existing contact ID
string
URL of the contact’s profile picture
string
ISO 3166-1 alpha-2 two-letter country code (e.g., ‘US’ for United States, ‘MY’ for Malaysia)
array
List of custom fields for the contact. Note: Custom fields must already exist in the workspace before they can be assigned to a contact

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RESPOND_IO_CREATE_SPACE_TAGCreates a new tag in the Respond.io workspace for organizing and categorizing contacts and conversations. Tags help with segmentation, filtering, and workflow automation. Each tag must have a unique name within the workspace.

Input Parameters

string
required
Name of the tag. Must be unique within the workspace. Cannot contain emojis or certain invalid characters. Supports spaces, letters, numbers, and common special characters like !@#$%.
string
(Optional) Hexadecimal color code for visual identification of the tag in the UI, e.g., ‘#FF5733’. Note: Currently the API may reject this parameter with validation errors.
string
(Optional) Brief text describing the tag’s purpose or usage. Helps team members understand when to apply this tag.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RESPOND_IO_GET_CONTACTRetrieve an existing Respond.io contact by ID, email, or phone number.

Input Parameters

string
required
Contact identifier with an id:, email:, or phone: prefix and a non-empty value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RESPOND_IO_GET_MESSAGETool to retrieve a specific message. Use when you need the details of a message sent to or received from a contact.

Input Parameters

integer
required
Unique ID of the message to retrieve.
string
required
Identifier of the contact, can be a phone number (‘+60121233112’), email (‘abdc@gmail.com’), or contact ID prefixed by ‘id:’ (e.g., ‘id:123’).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RESPOND_IO_LIST_CHANNELSTool to retrieve a list of channels connected to the workspace. Use when you need to enumerate all messaging channels with pagination support.

Input Parameters

integer
Number of items to return (page size). Default is 10, maximum 100.
integer
Pointer to the channel ID from where the next batch of records should start.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RESPOND_IO_LIST_CONTACTSList Respond.io contacts, optionally searching or filtering them.

Input Parameters

integer
Contacts per page, from 1 through 100.
object
Respond.io contact filter expression.
Free-text contact search.
integer
Cursor ID from a previous pagination URL.
string
IANA timezone used to evaluate filters.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RESPOND_IO_LIST_MESSAGESList one page of messages associated with a Respond.io contact.

Input Parameters

integer
Maximum number of messages to return.
integer
Cursor ID from a previous pagination URL.
string
required
Contact identifier with an id:, email:, or phone: prefix and a non-empty value.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RESPOND_IO_LIST_USERSRetrieves a list of respond.io workspace users for auditing or assignment.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: RESPOND_IO_UPDATE_SPACE_TAGUpdates an existing workspace tag by its current name. You can modify the tag’s name, description, or emoji. Note: Color codes are not currently supported by the API and will be rejected if provided. At least one field besides currentName must be provided to update.

Input Parameters

string
New name for the tag (if you want to rename it)
string
Emoji to associate with the tag (single emoji character)
string
Hex color code for the tag (Note: Currently not supported by API and will return error if provided)
string
required
The current name of the tag you want to update (must match exactly)
string
New description for the tag (updates or sets the description)

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not