API Reference

Contact Us

Zoko

Sign Up

Sign In

Get Customer

Authentication

Resources to communicate with your customers via social channel(s). These will help you send messages to your customers where they are.

Overview

Message API

How to send a message to a user using the API

Send a Message

Message History

Customer API

Agent API

Webhook API

Webhooks

What is a Webhook

When Do I Need One?

Enough Talk! Let's Build One

Webhook Payload by Event

Key Considerations

Retrieve approved templates for the account

Get Message Templates

Send message to customer on a specific channel

Send Message

Get Message

Delete a message
> **Note:** Deletion is only from Zoko database and will not affect the actual message(s) at the customer's client application.


Delete Message

Get Message History

Deletes a set of messages
> **Note:** Deletion is only from Zoko database and will not affect the actual message(s) at the customer's client application.


Delete Messages (bulk)

Get Customer List

Delete all messages for a customer. 
> **Note:** Deletion is only from Zoko database and will not affect the actual message(s) at the customer's client application.


Delete Messages

Customer Properties List

Create Customer Property

Get Customer Property

Update Customer Property

Delete Customer Property

List Customer Tags

Update all tags of a customer. Replaces the existing list of tags with the provided list. 


Update Customer Tags (Bulk)

Add Customer Tag

Delete Customer Tag

Assign Customer

Get Agent Details

Update an existing agent's role and availability


Update Agent

Get Agents

Get Teams

List Webhooks

Create Webhook

Get Webhook

Update Webhook

Delete Webhook