Superchat
App · 25 actions
Manage Superchat contacts, conversations, text messages, channels, labels and webhook subscriptions.
Actions
| Action | What it does |
|---|---|
| Create contact | Create a contact. |
| Create label | Create a label. |
| Create webhook | Create a webhook subscription. |
| Delete contact | Delete a contact. |
| Delete label | Delete a label. |
| Delete webhook | Delete a webhook subscription. |
| Get channel | Get a channel. |
| Get contact | Get a contact. |
| Get conversation | Get a conversation. |
| Get current user | Get current user. |
| Get message | Get a message. |
| Get template | Get a template. |
| List channels | List all channels. |
| List contacts | List all contacts. |
| List conversations | List all conversations. |
| List inboxes | List all inboxes. |
| List labels | List all labels. |
| List messages | Get conversation messages. |
| List templates | List all templates. |
| List users | List all users. |
| List webhooks | List all webhook subscriptions. |
| Search contacts | Search all contacts. |
| Send message | Send a message. |
| Update contact | Update a contact. |
| Update conversation | Update a conversation. |
Create contact
Create a contact.
Inputs
- First name
first_nametext - The first name of the contact
- Last name
last_nametext - The last name of the contact
- Gender
gendertext - The gender of the contactOne of:
male,female,diverse,unknown. Default:unknown. - Email address
emailtext - Email address for the new contact.
- Phone number
phonetext - Phone number for the new contact.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"created_at": "example",
"custom_attributes": [],
"first_name": "example",
"gender": "male",
"handles": [],
"id": "example",
"last_name": "example",
"updated_at": "example",
"url": "example"
}
}Create label
Create a label.
Inputs
- Name
nametextRequired - The name of the label
- Color
colortextRequired - The hex color of the label
- Folder ID
folder_idtext - The ID of the folder the label should be created in
Outputs
dataobject- Returned value.
Example output
{
"data": {
"color": "example",
"folder_id": "example",
"id": "example",
"name": "example",
"url": "example"
}
}Create webhook
Create a webhook subscription.
Inputs
- Events
eventslist - The webhook events to subscribe to
- Target url
target_urltextRequired - The HTTPS target URL that should receive webhook deliveries
Outputs
dataobject- Returned value.
Example output
{
"data": {
"created_at": "example",
"delivery": {
"reason": "repeated_delivery_failure",
"status": "active"
},
"events": [],
"id": "example",
"secret": "example",
"target_url": "example",
"updated_at": "example",
"url": "example"
}
}Delete contact
Delete a contact.
Inputs
- Contact
contact_idtextRequired - Public ID of the contact.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"id": "example"
}
}Delete label
Delete a label.
Inputs
- Label ID
label_idtextRequired - Public ID of the label.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"id": "example"
}
}Delete webhook
Delete a webhook subscription.
Inputs
- Subscription ID
subscription_idtextRequired - Public ID of the webhook subscription.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"id": "example"
}
}Get channel
Get a channel.
Inputs
- Channel
channel_idtextRequired - Public ID of the channel.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"id": "example",
"inbox": {
"id": "example",
"name": "example",
"url": "example"
},
"name": "example",
"phone_number": "example",
"type": "sms"
}
}Get contact
Get a contact.
Inputs
- Contact
contact_idtextRequired - Public ID of the contact.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"created_at": "example",
"custom_attributes": [],
"first_name": "example",
"gender": "male",
"handles": [],
"id": "example",
"last_name": "example",
"updated_at": "example",
"url": "example"
}
}Get conversation
Get a conversation.
Inputs
- Conversation
idtextRequired - Public ID of the conversation.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"assigned_users": [],
"channel": {
"id": "example",
"type": "sms",
"url": "example"
},
"contacts": [],
"id": "example",
"inbox": {
"id": "example",
"name": "example",
"url": "example"
},
"labels": [],
"snoozed_until": "example",
"status": "open",
"time_window": {
"open_until": "example",
"state": "open"
},
"url": "example"
}
}Get current user
Get current user.
Inputs
None.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"user": {
"email": "example",
"first_name": "example",
"id": "example",
"last_name": "example",
"phone": "example",
"role": "admin",
"url": "example"
},
"workspace": {
"name": "example"
}
}
}Get message
Get a message.
Inputs
- Id
idtextRequired - Public ID of the message.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"content": {
"body": "example",
"type": "text"
},
"conversation_id": "example",
"created_at": "example",
"direction": "inbound",
"from": {
"id": "example",
"identifier": "example",
"url": "example"
},
"id": "example",
"in_reply_to": "example",
"status": "processed",
"to": {
"channel_id": "example"
},
"updated_at": "example"
}
}Get template
Get a template.
Inputs
- Id
idtextRequired - Public ID of the template.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"channels": [],
"content": {
"body": "example",
"file_ids": [],
"type": "generic_template",
"variables": []
},
"created_at": "example",
"folder": {
"id": "example",
"name": "example",
"parent_id": "example"
},
"id": "example",
"name": "example",
"status": "submitted",
"updated_at": "example",
"url": "example"
}
}List channels
List all channels.
Inputs
- After
aftertext - Return channels after this channel ID.
- Before
beforetext - Return channels before this channel ID.
- Limit
limitnumber - Maximum number of channels to return.From 1 to 100. Default:
50.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"pagination": {
"next_cursor": "example",
"next_url": "example",
"previous_cursor": "example",
"previous_url": "example"
},
"results": [],
"url": "example"
}
}List contacts
List all contacts.
Inputs
- After
aftertext - Return contacts after this contact ID.
- Before
beforetext - Return contacts before this contact ID.
- Limit
limitnumber - Maximum number of contacts to return.From 1 to 100. Default:
50.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"pagination": {
"next_cursor": "example",
"next_url": "example",
"previous_cursor": "example",
"previous_url": "example"
},
"results": [],
"url": "example"
}
}List conversations
List all conversations.
Inputs
- After
aftertext - Return conversations after this conversation ID.
- Before
beforetext - Return conversations before this conversation ID.
- Limit
limitnumber - Maximum number of conversations to return.From 1 to 100. Default:
50.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"pagination": {
"next_cursor": "example",
"next_url": "example",
"previous_cursor": "example",
"previous_url": "example"
},
"results": [],
"url": "example"
}
}List inboxes
List all inboxes.
Inputs
- After
aftertext - Return inboxes after this inbox ID.
- Before
beforetext - Return inboxes before this inbox ID.
- Limit
limitnumber - Maximum number of inboxes to return.From 1 to 100. Default:
50.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"pagination": {
"next_cursor": "example",
"next_url": "example",
"previous_cursor": "example",
"previous_url": "example"
},
"results": [],
"url": "example"
}
}List labels
List all labels.
Inputs
- After
aftertext - Return labels after this label ID.
- Before
beforetext - Return labels before this label ID.
- Limit
limitnumber - Maximum number of labels to return.From 1 to 100. Default:
50.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"pagination": {
"next_cursor": "example",
"next_url": "example",
"previous_cursor": "example",
"previous_url": "example"
},
"results": [],
"url": "example"
}
}List messages
Get conversation messages.
Inputs
- Conversation
idtextRequired - Public ID of the conversation.
- After
aftertext - Return messages after this message ID.
- Before
beforetext - Return messages before this message ID.
- Created after
created_afterdate and time - Only return messages created after this ISO 8601 timestamp.
- Created before
created_beforedate and time - Only return messages created before this ISO 8601 timestamp.
- Direction
directiontext - Only return messages with this direction.One of:
INBOUND,OUTBOUND. - Limit
limitnumber - Maximum number of messages to return.From 1 to 100. Default:
20.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"pagination": {
"next_cursor": "example",
"next_url": "example",
"previous_cursor": "example",
"previous_url": "example"
},
"results": [],
"url": "example"
}
}List templates
List all templates.
Inputs
- After
aftertext - Return templates after this template ID.
- Before
beforetext - Return templates before this template ID.
- Channel
channel_idtext - Only return templates for this channel ID.
- Folder ID
folder_idtext - Only return templates in this folder ID.
- Limit
limitnumber - Maximum number of templates to return.From 1 to 100. Default:
50. - Type
typetext - Only return templates with this content type.One of:
generic_template(Generic template),whats_app_template(Whats app template).
Outputs
dataobject- Returned value.
Example output
{
"data": {
"pagination": {
"next_cursor": "example",
"next_url": "example",
"previous_cursor": "example",
"previous_url": "example"
},
"results": [],
"url": "example"
}
}List users
List all users.
Inputs
- After
aftertext - Return users after this user ID.
- Before
beforetext - Return users before this user ID.
- Limit
limitnumber - Maximum number of users to return.From 1 to 100. Default:
50.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"pagination": {
"next_cursor": "example",
"next_url": "example",
"previous_cursor": "example",
"previous_url": "example"
},
"results": [],
"url": "example"
}
}List webhooks
List all webhook subscriptions.
Inputs
- After
aftertext - Return webhook subscriptions after this subscription ID.
- Before
beforetext - Return webhook subscriptions before this subscription ID.
- Limit
limitnumber - Maximum number of webhook subscriptions to return.From 1 to 100. Default:
50.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"pagination": {
"next_cursor": "example",
"next_url": "example",
"previous_cursor": "example",
"previous_url": "example"
},
"results": [],
"url": "example"
}
}Search contacts
Search all contacts.
Inputs
- After
aftertext - Return contacts after this contact ID.
- Before
beforetext - Return contacts before this contact ID.
- Limit
limitnumber - Maximum number of contacts to return.From 1 to 100. Default:
50. - Search filters
query_valuelistRequired - The list of search expressions to evaluate
Outputs
dataobject- Returned value.
Example output
{
"data": {
"pagination": {
"next_cursor": "example",
"next_url": "example",
"previous_cursor": "example",
"previous_url": "example"
},
"results": [],
"url": "example"
}
}Send message
Send a message.
Inputs
- To
tolistRequired - The recipient list for the message
- From channel
from_channel_idtextRequired - The ID of the channel used to send the message
- From name
from_nametext - The display name to use as the sender
- Content body
content_bodytextRequired - The text body of the message
- In reply to
in_reply_totext - The ID of the message used to determine which conversation this new message is sent into
Outputs
dataobject- Returned value.
Example output
{
"data": {
"content": {
"body": "example",
"type": "text"
},
"conversation_id": "example",
"created_at": "example",
"direction": "outbound",
"from": {
"channel_id": "example",
"name": "example"
},
"id": "example",
"in_reply_to": "example",
"status": "processed",
"to": [],
"updated_at": "example",
"url": "example"
}
}Update contact
Update a contact.
Inputs
- Contact
contact_idtextRequired - Public ID of the contact.
- First name
first_nametext - The first name of the contact
- Last name
last_nametext - The last name of the contact
- Gender
gendertext - The gender of the contactOne of:
male,female,diverse,unknown. Default:unknown.
Outputs
dataobject- Returned value.
Example output
{
"data": {
"created_at": "example",
"custom_attributes": [],
"first_name": "example",
"gender": "male",
"handles": [],
"id": "example",
"last_name": "example",
"updated_at": "example",
"url": "example"
}
}Update conversation
Update a conversation.
Inputs
- Conversation
idtextRequired - Public ID of the conversation.
- Status
statustext - The new status of the conversationOne of:
open,done,spam,archived,snoozed. - Inbox
inbox_idtext - The ID of the inbox to assign to the conversation
- Snoozed until
snoozed_untildate and time - The time until which the conversation should be snoozed
- Assigned users
assigned_userslist - The IDs of the users to assign to the conversation
- Labels
labelslist - The IDs of the labels to assign to the conversation
Outputs
dataobject- Returned value.
Example output
{
"data": {
"assigned_users": [],
"channel": {
"id": "example",
"type": "sms",
"url": "example"
},
"contacts": [],
"id": "example",
"inbox": {
"id": "example",
"name": "example",
"url": "example"
},
"labels": [],
"snoozed_until": "example",
"status": "open",
"time_window": {
"open_until": "example",
"state": "open"
},
"url": "example"
}
}