Rasayel API Documentation
This is the complete API documentation for connecting to the Rasayel API using MindCloud's Universal API. If you are new to MindCloud, start with the Introduction to see how one API can sit in front of many different apps.
MindCloud is an integration company that offers one normalized API to access 3,100+ apps from a single place. It cleans up provider-specific quirks, keeps requests and responses consistent, and centralizes authentication so you do not need to manage separate flows for every app. Browse other apps.
Meet Rasayel: Manage conversations, contacts, campaigns, and messaging in Rasayel. Keep reading to get started.
Quickstart
Before you run your first Rasayel request, you need three things:
- A MindCloud account — sign in or create an account at MindCloud.
- A MindCloud API Key — create one in API Keys. Keep it on your server.
- At least one Rasayel connection — create or choose one in Connections. Note its
connectionId.
Every Rasayel action uses the same URL pattern:
https://connect.mindcloud.co/v1/universal/rasayel/latest/actions/{actionSlug}You need a MindCloud API Key and a Rasayel connection. Then call an action such as Get App:
curl --request GET \
--url "https://connect.mindcloud.co/v1/universal/rasayel/latest/actions/get-app" \
--header "Authorization: Bearer $MINDCLOUD_API_KEY" \
--get \
--data-urlencode "connectionId=$CONNECTION_ID"Every response comes back in the same envelope, with your rows in a data array:
{
"success": true,
"data": [
{ "id": "1042", "name": "Ava" }
],
"meta": {}
}After your first request works, use Shape your requests to control arguments, pagination, filtering, fields, and errors.
Authentication
Authentication has two layers. Your MindCloud API Key authenticates the request to MindCloud, sent as a Bearer token in the Authorization header. The connectionId selects the connected Rasayel account that should run the action. MindCloud stores and refreshes the Rasayel credentials behind that connection, so you never send provider tokens with your requests.
Pass connectionId in the query string for GET and DELETE actions, and in the JSON body for POST, PUT, and PATCH actions. Keep your MindCloud API Key on your server; do not ship it in browser code, mobile apps, public repositories, or logs.
Rasayel actions
All 32 published actions for this Rasayel version. Each page documents the endpoint, arguments, and response controls.
- PUTAssign Conversation
- PUTAssign Conversation Team
- POSTAttachment Image Upload From URL
- POSTAttachment Upload From URL
- POSTAttachment Video Upload From URL
- POSTCreate Channel User
- POSTCreate GIF Message
- POSTCreate Media Message
- POSTCreate Note Message
- POSTCreate Proactive Text Message
- POSTCreate Rich Message
- POSTCreate Template Message
- POSTCreate Text Message
- GETGet App
- GETGraphQL Query
- PUTSet Conversation State
- PUTSnooze Conversation
- PUTTag Channel User
- PUTTag Channel User By Tag ID
- PUTTag Conversation
- PUTTag Conversation By Tag ID
- PUTUnsnooze Conversation
- PUTUntag Channel User
- PUTUntag Conversation
- PUTUpdate Channel User
- PUTUpdate Channel User Bool Attribute
- PUTUpdate Channel User Date Attribute
- PUTUpdate Channel User Decimal Attribute
- PUTUpdate Channel User Identifier
- PUTUpdate Channel User Number Attribute
- PUTUpdate Channel User Select Attribute
- PUTUpdate Channel User Text Attribute
Related apps
More Communication apps on the Universal API, behind the same REST shape. Or browse all apps.