Channels
The channel object
Attributes
idstringIdentifier for this resource.
namestringHuman-readable name for this resource.
descriptionstringHuman-readable description of this resource.
profileUrlstringURL for the profile.
followersnumberSpecifies followers for this native channel.
mutedbooleanWhether notifications are muted.
previewbooleanWhether preview.
{
"id": "string",
"name": "string",
"description": "string",
"profileUrl": "string",
"followers": 0,
"muted": true,
"preview": true
}Create channel
- Base URL
https://api.polymorfa.com- Required permission
channels:manage
Path parameters
sessionstringrequiredIdentifier of the connected Polymorfa session.
Body
namestringrequiredmin length1Human-readable name for this resource.
descriptionstringHuman-readable description of this resource.
picturestringSpecifies picture for this native create channel request.
Responses
200Channel created
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 7 child fields
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl -X POST "https://api.polymorfa.com/messaging/<session>/channels" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"name": "string"
}'{
"success": true,
"data": {
"id": "string",
"name": "string",
"description": "string",
"profileUrl": "string",
"followers": 0,
"muted": true,
"preview": true
}
}List channels
- Base URL
https://api.polymorfa.com- Required permission
channels:read
Path parameters
sessionstringrequiredIdentifier of the connected Polymorfa session.
Responses
200Channel list
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataarray of objectrequiredStructured data carried by this object.
Show 7 child fields
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl "https://api.polymorfa.com/messaging/<session>/channels" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": [
{
"id": "string",
"name": "string",
"description": "string",
"profileUrl": "string",
"followers": 0,
"muted": true,
"preview": true
}
]
}List channel messages
- Base URL
https://api.polymorfa.com- Required permission
channels:read
Path parameters
sessionstringrequiredIdentifier of the connected Polymorfa session.
idstringrequiredpattern^[1-9][0-9]{0,18}$Identifier for this resource.
Query parameters
countintegerrange1–100Number of matching resources.
Default50beforeintegergreater than0Specifies before for this query parameter.
Responses
200Channel messages
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataarray of objectrequiredStructured data carried by this object.
Show 11 child fields
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl "https://api.polymorfa.com/messaging/<session>/channels/<id>/messages" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": [
{
"position": 0,
"id": "739182640518203",
"whatsapp_ids": {
"linked_devices": "string"
},
"conversation": {
"id": "739182640518203"
},
"type": "string",
"timestamp": "2026-09-22T12:00:00Z",
"views": 0,
"reactionCounts": {}
}
]
}List channel message updates
- Base URL
https://api.polymorfa.com- Required permission
channels:read
Path parameters
sessionstringrequiredIdentifier of the connected Polymorfa session.
idstringrequiredpattern^[1-9][0-9]{0,18}$Identifier for this resource.
Query parameters
countintegerrange1–100Number of matching resources.
Default50sinceintegernullablemin0Specifies since for this query parameter.
afterintegergreater than0Specifies after for this query parameter.
Responses
200Channel message updates
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataarray of objectrequiredStructured data carried by this object.
Show 11 child fields
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl "https://api.polymorfa.com/messaging/<session>/channels/<id>/message-updates" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": [
{
"position": 0,
"id": "739182640518203",
"whatsapp_ids": {
"linked_devices": "string"
},
"conversation": {
"id": "739182640518203"
},
"type": "string",
"timestamp": "2026-09-22T12:00:00Z",
"views": 0,
"reactionCounts": {}
}
]
}Get channel
- Base URL
https://api.polymorfa.com- Required permission
channels:read
Path parameters
sessionstringrequiredIdentifier of the connected Polymorfa session.
idstringrequiredpattern^[1-9][0-9]{0,18}$Identifier for this resource.
Responses
200Channel details
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 7 child fields
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl "https://api.polymorfa.com/messaging/<session>/channels/<id>" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": {
"id": "string",
"name": "string",
"description": "string",
"profileUrl": "string",
"followers": 0,
"muted": true,
"preview": true
}
}Mark channel message viewed
- Base URL
https://api.polymorfa.com- Required permission
channels:manage
Path parameters
sessionstringrequiredIdentifier of the connected Polymorfa session.
idstringrequiredpattern^[1-9][0-9]{0,18}$Identifier for this resource.
messageIdstringrequiredpattern^[1-9][0-9]{0,18}$Polymorfa message ID. Use the Polymorfa message's
idfor actions and replies.
Responses
200Message marked viewed
successbooleanrequiredWhether the request succeeded.
messagestringHuman-readable message associated with this result.
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl -X POST "https://api.polymorfa.com/messaging/<session>/channels/<id>/messages/<messageId>/viewed" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true
}React to channel message
- Base URL
https://api.polymorfa.com- Required permission
channels:manage
Path parameters
sessionstringrequiredIdentifier of the connected Polymorfa session.
idstringrequiredpattern^[1-9][0-9]{0,18}$Identifier for this resource.
messageIdstringrequiredpattern^[1-9][0-9]{0,18}$Polymorfa message ID. Use the Polymorfa message's
idfor actions and replies.
Headers
Idempotency-Keystringlength1–255Unique key, 1 to 255 bytes of UTF-8, that makes this write safe to retry for 1 hour. A retry with the same key, credential,
Polymorfa-Version, and request never runs the write again while its receipt is retained. Keep the first response. Exact response replay requires authorized replay data; opaque message or campaign bodies are not retained by default. An available exact replay carriesIdempotent-Replayed: true. Authorization, rate-limit and state refusals (401, 403, 408, 409, 423, 425, 429) are not recorded, so the same key can retry them. Reusing the key for a different request returns422 idempotency_conflict. A retry while the original is still running returns409 idempotency_in_progress, and a retry after an unrecorded outcome returns409 idempotency_outcome_unknown. If the recorded response cannot be read, the retry returns503 idempotency_replay_unavailablewithRetry-Afterand the write still does not run again.
Body
reactionstringrequiredmax length32Reaction applied to the referenced message.
Responses
200Reaction updated
successbooleanrequiredWhether the request succeeded.
messagestringHuman-readable message associated with this result.
Show 4 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
409The Idempotency-Key belongs to a request that is still running (`idempotency_in_progress`, with Retry-After) or whose outcome was not recorded (`idempotency_outcome_unknown`)
422The Idempotency-Key was already used for a different request (`idempotency_conflict`)
500Internal server error
503For `idempotency_replay_unavailable` only: the exact response for this Idempotency-Key is unavailable (with Retry-After). Opaque responses are not retained by default. The write did not run again. Keep the first response and reconcile events or the resource; waiting does not guarantee that replay data becomes available. Do not switch keys to resend
curl -X POST "https://api.polymorfa.com/messaging/<session>/channels/<id>/messages/<messageId>/reaction" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22" \
-H "Content-Type: application/json" \
-d '{
"reaction": "string"
}'{
"success": true
}Subscribe channel live updates
- Base URL
https://api.polymorfa.com- Required permission
channels:read
Path parameters
sessionstringrequiredIdentifier of the connected Polymorfa session.
idstringrequiredpattern^[1-9][0-9]{0,18}$Identifier for this resource.
Responses
200Live-update subscription duration
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 1 child field
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl -X POST "https://api.polymorfa.com/messaging/<session>/channels/<id>/live-updates" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": {
"durationSeconds": 0
}
}Follow channel
- Base URL
https://api.polymorfa.com- Required permission
channels:manage
Path parameters
sessionstringrequiredIdentifier of the connected Polymorfa session.
idstringrequiredpattern^[1-9][0-9]{0,18}$Identifier for this resource.
Responses
200Channel followed
successbooleanrequiredWhether the request succeeded.
messagestringHuman-readable message associated with this result.
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl -X POST "https://api.polymorfa.com/messaging/<session>/channels/<id>/follow" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true
}Unfollow channel
- Base URL
https://api.polymorfa.com- Required permission
channels:manage
Path parameters
sessionstringrequiredIdentifier of the connected Polymorfa session.
idstringrequiredpattern^[1-9][0-9]{0,18}$Identifier for this resource.
Responses
200Channel unfollowed
successbooleanrequiredWhether the request succeeded.
messagestringHuman-readable message associated with this result.
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl -X POST "https://api.polymorfa.com/messaging/<session>/channels/<id>/unfollow" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true
}Mute channel
- Base URL
https://api.polymorfa.com- Required permission
channels:manage
Path parameters
sessionstringrequiredIdentifier of the connected Polymorfa session.
idstringrequiredpattern^[1-9][0-9]{0,18}$Identifier for this resource.
Responses
200Channel muted
successbooleanrequiredWhether the request succeeded.
messagestringHuman-readable message associated with this result.
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl -X POST "https://api.polymorfa.com/messaging/<session>/channels/<id>/mute" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true
}Unmute channel
- Base URL
https://api.polymorfa.com- Required permission
channels:manage
Path parameters
sessionstringrequiredIdentifier of the connected Polymorfa session.
idstringrequiredpattern^[1-9][0-9]{0,18}$Identifier for this resource.
Responses
200Channel unmuted
successbooleanrequiredWhether the request succeeded.
messagestringHuman-readable message associated with this result.
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
curl -X POST "https://api.polymorfa.com/messaging/<session>/channels/<id>/unmute" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true
}Delete channel
- Base URL
https://api.polymorfa.com- Required permission
channels:manage
Path parameters
sessionstringrequiredIdentifier of the connected Polymorfa session.
idstringrequiredpattern^[1-9][0-9]{0,18}$Identifier for this resource.
Responses
200Channel deleted
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured data carried by this object.
Show 1 child field
Show 3 headers
400Bad request — request body or params failed validation
401Missing or invalid authentication token
403Authenticated but not permitted (missing scope or rule violation)
404Resource not found
500Internal server error
502Upstream WhatsApp request failed or its response could not be mapped
curl -X DELETE "https://api.polymorfa.com/messaging/<session>/channels/<id>" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": {
"status": "DELETED"
}
}