Fetches a list of contacts associated with the specified channel (e.g., WhatsApp).
Click to expand full details
GET /api/public/channels/{channelType}/contacts
Name Type Required Description channelTypestring ✅ The channel type (e.g., whatsapp)
Name Type Required Description pagenumber ❌ Page number for pagination
Name Type Required Description x-api-keystring ✅ Your API key for authorization
Bash
curl --request GET \
'https://iris-backend-production.up.railway.app/api/public/channels/whatsapp/contacts?page=1' \
--header 'x-api-key: YOUR_API_KEY'
JSON
[
{
"id": "contact_01",
"name": "Pedro",
"phone": "+5511999999999",
"tags": ["lead"]
},
...
]
Retrieves the authenticated user's channel info for a given channel type.
Click to expand full details
GET /api/public/channels/{channelType}
Name Type Required Description channelTypestring ✅ Channel type (e.g., whatsapp)
Name Type Required Description x-api-keystring ✅ Your API key for authorization
Bash
curl --request GET \
'https://iris-backend-production.up.railway.app/api/public/channels/whatsapp' \
--header 'x-api-key: YOUR_API_KEY'
JSON
{
"id": "channel_01",
"type": "whatsapp",
"name": "Main WhatsApp Channel",
"status": "connected"
}
Adds tags to a contact identified by their phone number or platform ID.
Click to expand full details
POST /api/public/channels/{channelType}/{platformIdentifier}/tags
Name Type Required Description channelTypestring ✅ The channel type (e.g., whatsapp) platformIdentifierstring ✅ Phone number or username (e.g., +5511999999999)
JSON
{
"tags": ["event_signup", "VIP"]
}
Name Type Required Description x-api-keystring ✅ Your API key for authorization
Bash
curl --request POST \
'https://iris-backend-production.up.railway.app/api/public/channels/whatsapp/+5511999999999/tags' \
--header 'x-api-key: YOUR_API_KEY' \
--header 'Content-Type: application/json' \
--data-raw '{
"tags": ["event_signup", "VIP"]
}'
JSON
{
"status": "success",
"message": "Tags added to contact"
}
