Stickers
The sticker mutation receipt object
Attributes
statusstringrequiredCurrent status of this resource or operation.
Allowed valuesapplied
{
"status": "applied"
}List stored stickers
- 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 length1Identifier of the connected Polymorfa session.
Query parameters
limitintegerrange1–100Specifies limit for this query parameter.
Default50cursorstringpattern^[A-Za-z0-9+/]{43}=$Specifies cursor for this query parameter.
collectionstringSpecifies collection for this query parameter.
Allowed valuesrecentfavoriteDefault"recent"
Responses
200One page of retained stickers
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataarray of objectrequiredStructured data carried by this object.
Show 8 child fields
nextCursorstringrequirednullableSpecifies 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.
curl "https://api.polymorfa.com/messaging/<session>/stickers" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": [
{
"fileSha256": "string",
"favorite": true
}
],
"nextCursor": "string"
}Set sticker favorite
- Base URL
https://api.polymorfa.com- Required permission
profile:write
Path parameters
sessionstringrequiredmin length1Identifier of the connected Polymorfa session.
Body
fileSha256stringrequiredpattern^[A-Za-z0-9+/]{43}=$Specifies file sha256 for this one of.
favoritebooleanrequiredWhether favorite.
Allowed valuesfalse
Responses
200App-state patch accepted
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 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
}'{
"success": true,
"data": {
"status": "applied"
}
}Remove recent sticker
- Base URL
https://api.polymorfa.com- Required permission
profile:write
Path parameters
sessionstringrequiredmin length1Identifier of the connected Polymorfa session.
Body
fileSha256stringrequiredpattern^[A-Za-z0-9+/]{43}=$Specifies file sha256 for this native remove recent sticker request.
lastStickerSentTsintegerrequiredrange0–9007199254740991Most recent use observed by the caller, in Unix milliseconds. A later use is preserved.
Responses
200App-state patch accepted
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 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
}'{
"success": true,
"data": {
"status": "applied"
}
}Request sticker reupload
- 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 length1Identifier 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
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured 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
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"
]
}'{
"success": true,
"data": {
"status": "requested",
"requestId": "string"
}
}Bootstrap recent stickers
- 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 length1Identifier of the connected Polymorfa session.
Responses
200Phone request sent
successbooleanrequiredWhether the request succeeded.
Allowed valuestruedataobjectrequiredStructured 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
curl -X POST "https://api.polymorfa.com/messaging/<session>/stickers/recents/bootstrap" \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Polymorfa-Version: 2026-09-22"{
"success": true,
"data": {
"status": "requested",
"requestId": "string"
}
}