API
An alternative to our SDK - for submitting custom attributes to new or existing customers.
What can you use the Mava API for?
Custom Attributes: You can use the Mava API to push user attributes to Mava via the identify endpoint. This offers similar functionality to the web chat SDK but can be used with all integration options and enables you to push data from third-party systems, such as your database, into Mava.
Status Updates: You can use the API to update ticket statuses, for example to close them.
Ticket Updates: You can use the API to update tickets, for example adding a tag or category.
Private Notes: You can use the API to add private notes to tickets.
Messages: sending messages via API is coming soon.
Creating Tickets: creating tickets is coming soon
We're expanding our API so if you're looking to build more with the Mava API please send us a message or book a feedback call.
Getting Started
Head over to the API section within the Mava dashboard and create an API key.
Please note: If you send no customer ID, a customer will be created for you and a new customer ID sent back which should be stored and used for subsequent calls to update that same customer.
CURL
NodeJS
Schema
API Endpoints
1. Get Categories
Retrieves a list of all active categories for the authenticated client.
Endpoint
Authentication
Requires API token authentication
Subject to rate limiting
Response
Success (200 OK)
Error (500 Internal Server Error)
2. Update Ticket
Updates a ticket's status, priority, and/or category.
Endpoint
Authentication
Requires API token authentication
Subject to rate limiting
Request Body
ticketId
string
Yes
The unique identifier of the ticket
status
string
No
New ticket status
priority
number
No
New priority level
categoryId
string
No
ID of the category to assign
Valid Values
Status:
"Open"
,"Resolved"
,"Pending"
,"Waiting"
Priority:
1
,2
,3
CategoryId: Must be a valid category ID from GET /categories
Response
Success (200 OK)
Error Responses
Ticket not found (400)
Invalid category (400)
Invalid status/priority (400)
Server error (500)
Behavior
Each change (status, priority, category) creates an audit log message
Changes are only made if the new value differs from the current value
Category must be active (not archived) and belong to the client
Last updated
Was this helpful?