Superchat

App · 25 actions

Manage Superchat contacts, conversations, text messages, channels, labels and webhook subscriptions.

Actions

ActionWhat it does
Create contactCreate a contact.
Create labelCreate a label.
Create webhookCreate a webhook subscription.
Delete contactDelete a contact.
Delete labelDelete a label.
Delete webhookDelete a webhook subscription.
Get channelGet a channel.
Get contactGet a contact.
Get conversationGet a conversation.
Get current userGet current user.
Get messageGet a message.
Get templateGet a template.
List channelsList all channels.
List contactsList all contacts.
List conversationsList all conversations.
List inboxesList all inboxes.
List labelsList all labels.
List messagesGet conversation messages.
List templatesList all templates.
List usersList all users.
List webhooksList all webhook subscriptions.
Search contactsSearch all contacts.
Send messageSend a message.
Update contactUpdate a contact.
Update conversationUpdate a conversation.

Create contact

Create a contact.

Inputs

First namefirst_nametext
The first name of the contact
Last namelast_nametext
The last name of the contact
Gendergendertext
The gender of the contactOne of: male, female, diverse, unknown. Default: unknown.
Email addressemailtext
Email address for the new contact.
Phone numberphonetext
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

NamenametextRequired
The name of the label
ColorcolortextRequired
The hex color of the label
Folder IDfolder_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

Eventseventslist
The webhook events to subscribe to
Target urltarget_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

Contactcontact_idtextRequired
Public ID of the contact.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "id": "example"
  }
}

Delete label

Delete a label.

Inputs

Label IDlabel_idtextRequired
Public ID of the label.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "id": "example"
  }
}

Delete webhook

Delete a webhook subscription.

Inputs

Subscription IDsubscription_idtextRequired
Public ID of the webhook subscription.

Outputs

dataobject
Returned value.
Example output
{
  "data": {
    "id": "example"
  }
}

Get channel

Get a channel.

Inputs

Channelchannel_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

Contactcontact_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

ConversationidtextRequired
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

IdidtextRequired
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

IdidtextRequired
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

Afteraftertext
Return channels after this channel ID.
Beforebeforetext
Return channels before this channel ID.
Limitlimitnumber
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

Afteraftertext
Return contacts after this contact ID.
Beforebeforetext
Return contacts before this contact ID.
Limitlimitnumber
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

Afteraftertext
Return conversations after this conversation ID.
Beforebeforetext
Return conversations before this conversation ID.
Limitlimitnumber
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

Afteraftertext
Return inboxes after this inbox ID.
Beforebeforetext
Return inboxes before this inbox ID.
Limitlimitnumber
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

Afteraftertext
Return labels after this label ID.
Beforebeforetext
Return labels before this label ID.
Limitlimitnumber
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

ConversationidtextRequired
Public ID of the conversation.
Afteraftertext
Return messages after this message ID.
Beforebeforetext
Return messages before this message ID.
Created aftercreated_afterdate and time
Only return messages created after this ISO 8601 timestamp.
Created beforecreated_beforedate and time
Only return messages created before this ISO 8601 timestamp.
Directiondirectiontext
Only return messages with this direction.One of: INBOUND, OUTBOUND.
Limitlimitnumber
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

Afteraftertext
Return templates after this template ID.
Beforebeforetext
Return templates before this template ID.
Channelchannel_idtext
Only return templates for this channel ID.
Folder IDfolder_idtext
Only return templates in this folder ID.
Limitlimitnumber
Maximum number of templates to return.From 1 to 100. Default: 50.
Typetypetext
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

Afteraftertext
Return users after this user ID.
Beforebeforetext
Return users before this user ID.
Limitlimitnumber
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

Afteraftertext
Return webhook subscriptions after this subscription ID.
Beforebeforetext
Return webhook subscriptions before this subscription ID.
Limitlimitnumber
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

Afteraftertext
Return contacts after this contact ID.
Beforebeforetext
Return contacts before this contact ID.
Limitlimitnumber
Maximum number of contacts to return.From 1 to 100. Default: 50.
Search filtersquery_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

TotolistRequired
The recipient list for the message
From channelfrom_channel_idtextRequired
The ID of the channel used to send the message
From namefrom_nametext
The display name to use as the sender
Content bodycontent_bodytextRequired
The text body of the message
In reply toin_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

Contactcontact_idtextRequired
Public ID of the contact.
First namefirst_nametext
The first name of the contact
Last namelast_nametext
The last name of the contact
Gendergendertext
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

ConversationidtextRequired
Public ID of the conversation.
Statusstatustext
The new status of the conversationOne of: open, done, spam, archived, snoozed.
Inboxinbox_idtext
The ID of the inbox to assign to the conversation
Snoozed untilsnoozed_untildate and time
The time until which the conversation should be snoozed
Assigned usersassigned_userslist
The IDs of the users to assign to the conversation
Labelslabelslist
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"
  }
}

On this page