/v1/stickerpacks
Use the stickerpacks
node to manage both first-party and third-party stickerpacks and stickers.
This document covers:
GET /v1/stickerpacks?namespace=whatsapp
{ "stickerpacks": [ {"id": "sticker-pack-id1"}, {"id": "sticker-pack-id2"} ] }
GET /v1/stickerpacks/sticker-pack-id?namespace=whatsapp
{ "stickerpacks": [ { "publisher" : "sticker-pack-publisher-name", "name": "sticker-pack-name" } ] }
GET /v1/stickerpacks/sticker-pack-id/stickers?namespace=whatsapp
{ "stickers": [ {"index": "sticker-index1"}, {"index": "sticker-index2"} ] }
GET /v1/stickerpacks/sticker-pack-id/stickers/sticker-index?namespace=whatsapp
{ "stickers": [ { "id": "sticker-media-id" # ex: b942a4d1-4e1d-4c56-8cfa-a848b8222061 "emojis": ["🐥", "😃"], } ] }
POST /v1/stickerpacks { "publisher" : "your-publisher-name", "name": "your-sticker-pack-name", "ios_app_store_link" : "https://itunes.apple.com/app/id3133333", "android_app_store_link" : "https://play.google.com/store/apps/details?id=com.example", }
Name | Required | Description |
---|---|---|
| Yes | The name of the publisher of the third-party stickerpack |
| Yes | The name of the stickerpack |
| No | A link to the stickerpack in the Apple iOS App Store |
| No | A link to the stickerpack in the Google Play store |
{ "stickerpacks": [ { "id": "sticker-pack-id" } ] }
GET /v1/stickerpacks
{ "stickerpacks": [ {"id": "sticker-pack-id1"}, {"id": "sticker-pack-id2"} ] }
GET /v1/stickerpacks/your-sticker-pack-id
{ "stickerpacks": [ { "publisher" : "sticker-pack-publisher-name", "name": "sticker-pack-name", "ios_app_store_link" : "https://itunes.apple.com/app/id3133333", "android_app_store_link" : "https://play.google.com/store/apps/details?id=com.example", } ] }
PATCH /v1/stickerpacks/your-sticker-pack-id { "publisher" : "your-publisher-name", "name": "your-sticker-pack-name", "ios_app_store_link" : "https://itunes.apple.com/app/id3133333", "android_app_store_link" : "https://play.google.com/store/apps/details?id=com.example", }
Name | Required | Description |
---|---|---|
| No | The name of the publisher of the third-party stickerpack |
| No | The name of the stickerpack |
| No | A link to the stickerpack in the Apple iOS App Store |
| No | A link to the stickerpack in the Google Play store |
A successful response will show 200 OK
and either null
or {}
.
null or {}
DELETE /v1/stickerpacks/your-sticker-pack-id
A successful response will show 200 OK
and either null
or {}
.
null or {}
POST /v1/stickerpacks/your-sticker-pack-id/stickers { "image_data_id" : "your-sticker-image-media-id", "emojis": ["🐥", "😃"] }
Name | Required | Description |
---|---|---|
| Yes | The ID for the sticker media |
| No | An array of the emojis included in the stickerpack |
{ "stickers": [{ "index": "sticker-index" }] }
GET /v1/stickerpacks/your-sticker-pack-id/stickers
{ "stickers": [ {"index": "sticker-index1"}, {"index": "sticker-index2"} ] }
GET /v1/stickerpacks/your-sticker-pack-id/stickers/your-sticker-index
{ "stickers": [ { "id": "sticker-media-id" # ex: b942a4d1-4e1d-4c56-8cfa-a848b8222061 "emojis": ["🐥", "😃"], "image_data_id" : "sticker-image-media-id", } ] }
PATCH /v1/stickerpacks/your-sticker-pack-id/stickers/your-sticker-index { "image_data_id" : "your-sticker-image-media-id", "emojis": ["🐥", "😃"], }
Name | Required | Description |
---|---|---|
| No | The ID for the sticker media |
| No | An array of the emojis included in the stickerpack |
A successful response will show 200 OK
and either null
or {}
.
null or {}
DELETE /v1/stickerpacks/your-sticker-pack-id/stickers/your-sticker-index
A successful response will show 200 OK
and either null
or {}
.
null or {}