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

Stickers

View as Markdown

The sticker mutation receipt object

Attributes

  • statusstringrequired

    Current status of this resource or operation.

    Allowed valuesapplied
The sticker mutation receipt object
{
  "status": "applied"
}

List stored stickers

GET/messaging/{session}/stickersMessaging APILinked Device API
Base URL
https://api.polymorfa.com

Required scopes (all): messages:read · media:read

Requires HMS, live customer authority and media:read. References may be partial or expired. This is retained account state, not a directory of all installed packs.

Path parameters

  • sessionstringrequiredmin length1

    Identifier of the connected Polymorfa session.

Query parameters

  • limitintegerrange1–100

    Specifies limit for this query parameter.

    Default 50
  • cursorstringpattern^[A-Za-z0-9+/]{43}=$

    Specifies cursor for this query parameter.

  • collectionstring

    Specifies collection for this query parameter.

    Allowed valuesrecentfavorite
    Default "recent"

Responses

  • 200One page of retained stickers
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataarray of objectrequired

      Structured data carried by this object.

      Show 8 child fields
    • nextCursorstringrequirednullable

      Specifies next cursor for this native stored stickers response.

    Show 4 headers
  • 400A filter or cursor is invalid.
  • 401The credential is missing or invalid.
  • 403The credential lacks the scope, is a client token without the `conversations_read` action, or the team is not enrolled in the beta.
  • 404The Number or conversation is unavailable, or hosted message storage is not enabled (`hms_not_enabled`).
  • 503The history service for the Number's data region is unavailable.
GET /messaging/{session}/stickerscURL
Not available with the Test key. Use a team key or project token.
curl "https://api.polymorfa.com/messaging/<session>/stickers" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true,
  "data": [
    {
      "fileSha256": "string",
      "favorite": true
    }
  ],
  "nextCursor": "string"
}

Set sticker favorite

PUT/messaging/{session}/stickers/favoriteMessaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
profile:write

Path parameters

  • sessionstringrequiredmin length1

    Identifier of the connected Polymorfa session.

Body

One of
  • fileSha256stringrequiredpattern^[A-Za-z0-9+/]{43}=$

    Specifies file sha256 for this one of.

  • favoritebooleanrequired

    Whether favorite.

    Allowed valuesfalse

Responses

  • 200App-state patch accepted
    • 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
PUT /messaging/{session}/stickers/favoritecURL
Not available with the Test key. Use a team key or project token.
curl -X PUT "https://api.polymorfa.com/messaging/<session>/stickers/favorite" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22" \
  -H "Content-Type: application/json" \
  -d '{
  "fileSha256": "string",
  "favorite": false
}'
Response
{
  "success": true,
  "data": {
    "status": "applied"
  }
}

Remove recent sticker

POST/messaging/{session}/stickers/recents/removeMessaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
profile:write

Path parameters

  • sessionstringrequiredmin length1

    Identifier of the connected Polymorfa session.

Body

  • fileSha256stringrequiredpattern^[A-Za-z0-9+/]{43}=$

    Specifies file sha256 for this native remove recent sticker request.

  • lastStickerSentTsintegerrequiredrange0–9007199254740991

    Most recent use observed by the caller, in Unix milliseconds. A later use is preserved.

Responses

  • 200App-state patch accepted
    • 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
POST /messaging/{session}/stickers/recents/removecURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/messaging/<session>/stickers/recents/remove" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22" \
  -H "Content-Type: application/json" \
  -d '{
  "fileSha256": "string",
  "lastStickerSentTs": 0
}'
Response
{
  "success": true,
  "data": {
    "status": "applied"
  }
}

Request sticker reupload

POST/messaging/{session}/stickers/reuploadsMessaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
media:read

The receipt confirms a request, not a completed upload. Consume sticker.update events for per-sticker results. Available to managed Linked Devices connections.

Path parameters

  • sessionstringrequiredmin length1

    Identifier of the connected Polymorfa session.

Body

  • fileSha256sarray of stringrequireditems1–100item pattern^[A-Za-z0-9+/]{43}=$

    File sha256s associated with this native reupload stickers request.

Responses

  • 200Phone request sent
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured data carried by this object.

      Show 2 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
  • 502Upstream WhatsApp request failed or its response could not be mapped
POST /messaging/{session}/stickers/reuploadscURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/messaging/<session>/stickers/reuploads" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22" \
  -H "Content-Type: application/json" \
  -d '{
  "fileSha256s": [
    "string"
  ]
}'
Response
{
  "success": true,
  "data": {
    "status": "requested",
    "requestId": "string"
  }
}

Bootstrap recent stickers

POST/messaging/{session}/stickers/recents/bootstrapMessaging APILinked Device API
Base URL
https://api.polymorfa.com
Required permission
messages:read

Requests a history-sync bootstrap. Consume history.sync or the authorized HMS catalog. The phone may be unavailable; this response does not confirm delivery of its history.

Path parameters

  • sessionstringrequiredmin length1

    Identifier of the connected Polymorfa session.

Responses

  • 200Phone request sent
    • successbooleanrequired

      Whether the request succeeded.

      Allowed valuestrue
    • dataobjectrequired

      Structured data carried by this object.

      Show 2 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
  • 502Upstream WhatsApp request failed or its response could not be mapped
POST /messaging/{session}/stickers/recents/bootstrapcURL
Not available with the Test key. Use a team key or project token.
curl -X POST "https://api.polymorfa.com/messaging/<session>/stickers/recents/bootstrap" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Polymorfa-Version: 2026-09-22"
Response
{
  "success": true,
  "data": {
    "status": "requested",
    "requestId": "string"
  }
}