Skip to content
Shortcut: /, ⌘K or Ctrl+K

Channels

View as Markdown

The channel object

Attributes

  • idstring

    Identifier for this resource.

  • namestring

    Human-readable name for this resource.

  • descriptionstring

    Human-readable description of this resource.

  • profileUrlstring

    URL for the profile.

  • followersnumber

    Specifies followers for this native channel.

  • mutedboolean

    Whether notifications are muted.

  • previewboolean

    Whether preview.

The channel object
{
  "id": "string",
  "name": "string",
  "description": "string",
  "profileUrl": "string",
  "followers": 0,
  "muted": true,
  "preview": true
}

Create channel

POST/messaging/{session}/channelsMessaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
channels:manage

Path parameters

  • sessionstringrequired

    Identifier of the connected Polymorfa session.

Body

  • namestringrequiredmin length1

    Human-readable name for this resource.

  • descriptionstring

    Human-readable description of this resource.

  • picturestring

    Specifies picture for this native create channel request.

Responses

  • 200Channel created
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured 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
POST /messaging/{session}/channelscURL
Not available with the Test key. Use a team key or project token.
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"
}'
Response
{
  "success": true,
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "profileUrl": "string",
    "followers": 0,
    "muted": true,
    "preview": true
  }
}

List channels

GET/messaging/{session}/channelsMessaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
channels:read

Path parameters

  • sessionstringrequired

    Identifier of the connected Polymorfa session.

Responses

  • 200Channel list
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataarray of objectrequired

      Structured 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
GET /messaging/{session}/channelscURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/messaging/<session>/channels" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true,
  "data": [
    {
      "id": "string",
      "name": "string",
      "description": "string",
      "profileUrl": "string",
      "followers": 0,
      "muted": true,
      "preview": true
    }
  ]
}

List channel messages

GET/messaging/{session}/channels/{id}/messagesMessaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
channels:read

Path parameters

  • sessionstringrequired

    Identifier of the connected Polymorfa session.

  • idstringrequiredpattern^[1-9][0-9]{0,18}$

    Identifier for this resource.

Query parameters

  • countintegerrange1–100

    Number of matching resources.

    Default 50
  • beforeintegergreater than0

    Specifies before for this query parameter.

Responses

  • 200Channel messages
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataarray of objectrequired

      Structured 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
GET /messaging/{session}/channels/{id}/messagescURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/messaging/<session>/channels/<id>/messages" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "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

GET/messaging/{session}/channels/{id}/message-updatesMessaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
channels:read

Path parameters

  • sessionstringrequired

    Identifier of the connected Polymorfa session.

  • idstringrequiredpattern^[1-9][0-9]{0,18}$

    Identifier for this resource.

Query parameters

  • countintegerrange1–100

    Number of matching resources.

    Default 50
  • sinceintegernullablemin0

    Specifies since for this query parameter.

  • afterintegergreater than0

    Specifies after for this query parameter.

Responses

  • 200Channel message updates
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataarray of objectrequired

      Structured 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
GET /messaging/{session}/channels/{id}/message-updatescURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/messaging/<session>/channels/<id>/message-updates" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "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

GET/messaging/{session}/channels/{id}Messaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
channels:read

Path parameters

  • sessionstringrequired

    Identifier of the connected Polymorfa session.

  • idstringrequiredpattern^[1-9][0-9]{0,18}$

    Identifier for this resource.

Responses

  • 200Channel details
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured 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
GET /messaging/{session}/channels/{id}cURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/messaging/<session>/channels/<id>" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true,
  "data": {
    "id": "string",
    "name": "string",
    "description": "string",
    "profileUrl": "string",
    "followers": 0,
    "muted": true,
    "preview": true
  }
}

Mark channel message viewed

POST/messaging/{session}/channels/{id}/messages/{messageId}/viewedMessaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
channels:manage

Path parameters

  • sessionstringrequired

    Identifier 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 id for actions and replies.

Responses

  • 200Message marked viewed
    • successbooleanrequired

      Whether the request succeeded.

    • messagestring

      Human-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
POST /messaging/{session}/channels/{id}/messages/{messageId}/viewedcURL
Not available with the Test key. Use a team key or project token.
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"
Response
{
  "success": true
}

React to channel message

POST/messaging/{session}/channels/{id}/messages/{messageId}/reactionMessaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
channels:manage

Path parameters

  • sessionstringrequired

    Identifier 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 id for actions and replies.

Headers

  • Idempotency-Keystringlength1–255

    Unique 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 carries Idempotent-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 returns 422 idempotency_conflict. A retry while the original is still running returns 409 idempotency_in_progress, and a retry after an unrecorded outcome returns 409 idempotency_outcome_unknown. If the recorded response cannot be read, the retry returns 503 idempotency_replay_unavailable with Retry-After and the write still does not run again.

Body

  • reactionstringrequiredmax length32

    Reaction applied to the referenced message.

Responses

  • 200Reaction updated
    • successbooleanrequired

      Whether the request succeeded.

    • messagestring

      Human-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
POST /messaging/{session}/channels/{id}/messages/{messageId}/reactioncURL
Not available with the Test key. Use a team key or project token.
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"
}'
Response
{
  "success": true
}

Subscribe channel live updates

POST/messaging/{session}/channels/{id}/live-updatesMessaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
channels:read

Path parameters

  • sessionstringrequired

    Identifier of the connected Polymorfa session.

  • idstringrequiredpattern^[1-9][0-9]{0,18}$

    Identifier for this resource.

Responses

  • 200Live-update subscription duration
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured 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
POST /messaging/{session}/channels/{id}/live-updatescURL
Not available with the Test key. Use a team key or project token.
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"
Response
{
  "success": true,
  "data": {
    "durationSeconds": 0
  }
}

Follow channel

POST/messaging/{session}/channels/{id}/followMessaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
channels:manage

Path parameters

  • sessionstringrequired

    Identifier of the connected Polymorfa session.

  • idstringrequiredpattern^[1-9][0-9]{0,18}$

    Identifier for this resource.

Responses

  • 200Channel followed
    • successbooleanrequired

      Whether the request succeeded.

    • messagestring

      Human-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
POST /messaging/{session}/channels/{id}/followcURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/messaging/<session>/channels/<id>/follow" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true
}

Unfollow channel

POST/messaging/{session}/channels/{id}/unfollowMessaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
channels:manage

Path parameters

  • sessionstringrequired

    Identifier of the connected Polymorfa session.

  • idstringrequiredpattern^[1-9][0-9]{0,18}$

    Identifier for this resource.

Responses

  • 200Channel unfollowed
    • successbooleanrequired

      Whether the request succeeded.

    • messagestring

      Human-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
POST /messaging/{session}/channels/{id}/unfollowcURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/messaging/<session>/channels/<id>/unfollow" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true
}

Mute channel

POST/messaging/{session}/channels/{id}/muteMessaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
channels:manage

Path parameters

  • sessionstringrequired

    Identifier of the connected Polymorfa session.

  • idstringrequiredpattern^[1-9][0-9]{0,18}$

    Identifier for this resource.

Responses

  • 200Channel muted
    • successbooleanrequired

      Whether the request succeeded.

    • messagestring

      Human-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
POST /messaging/{session}/channels/{id}/mutecURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/messaging/<session>/channels/<id>/mute" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true
}

Unmute channel

POST/messaging/{session}/channels/{id}/unmuteMessaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
channels:manage

Path parameters

  • sessionstringrequired

    Identifier of the connected Polymorfa session.

  • idstringrequiredpattern^[1-9][0-9]{0,18}$

    Identifier for this resource.

Responses

  • 200Channel unmuted
    • successbooleanrequired

      Whether the request succeeded.

    • messagestring

      Human-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
POST /messaging/{session}/channels/{id}/unmutecURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/messaging/<session>/channels/<id>/unmute" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true
}

Delete channel

DELETE/messaging/{session}/channels/{id}Messaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
channels:manage

Path parameters

  • sessionstringrequired

    Identifier of the connected Polymorfa session.

  • idstringrequiredpattern^[1-9][0-9]{0,18}$

    Identifier for this resource.

Responses

  • 200Channel deleted
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured 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
DELETE /messaging/{session}/channels/{id}cURL
Not available with the Test key. Use a team key or project token.
curl -X DELETE "https://api.polymorfa.com/messaging/<session>/channels/<id>" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true,
  "data": {
    "status": "DELETED"
  }
}