Stickerpack Management

/v1/stickerpacks

Use the stickerpacks node to manage both first-party and third-party stickerpacks and stickers.

This document covers:

First-party Stickerpacks

Retrieving First-party Stickerpacks

Request

GET /v1/stickerpacks?namespace=whatsapp

Response

{
  "stickerpacks": [
    {"id": "sticker-pack-id1"},
    {"id": "sticker-pack-id2"}
  ]
}

Retrieving First-party Stickerpack Information

Request

GET /v1/stickerpacks/sticker-pack-id?namespace=whatsapp

Response

{
  "stickerpacks": [
    {
      "publisher" : "sticker-pack-publisher-name",
      "name": "sticker-pack-name"
    }
  ]
}

First-party Stickers

Retrieving First-party Stickers

Request

GET /v1/stickerpacks/sticker-pack-id/stickers?namespace=whatsapp

Response

{
  "stickers": [
    {"index": "sticker-index1"},
    {"index": "sticker-index2"}
  ]
}

Retrieving First-party Sticker Information

Request

GET /v1/stickerpacks/sticker-pack-id/stickers/sticker-index?namespace=whatsapp

Response

{
  "stickers": [
    {
      "id": "sticker-media-id" # ex: b942a4d1-4e1d-4c56-8cfa-a848b8222061
      "emojis": ["🐥", "😃"],
    }
  ]
}

Third-party Stickerpacks

Creating Third-party Stickerpacks

Request

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",
}

Parameters

NameRequiredDescription

publisher

Yes

The name of the publisher of the third-party stickerpack

name

Yes

The name of the stickerpack

ios_app_store_link

No

A link to the stickerpack in the Apple iOS App Store
The link follows the format https://itunes.apple.com/app/idXXXXXXXXX
To get your App Store link, refer to the instructions at https://stackoverflow.com/questions/4137426/get-itunes-link-for-app-before-submitting

android_app_store_link

No

A link to the stickerpack in the Google Play store
The link follows the format https://play.google.com/store/apps/details?id=com.example where com.example is your app's package name

Response

{
  "stickerpacks": [
    {
      "id": "sticker-pack-id"
    }
  ]
}

Retrieving Third-party Stickerpacks

Request

GET /v1/stickerpacks

Response

{
  "stickerpacks": [
    {"id": "sticker-pack-id1"},
    {"id": "sticker-pack-id2"}
  ]
}

Retrieving Third-party Stickerpack Information

Request

GET /v1/stickerpacks/your-sticker-pack-id

Response

{
  "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",
    }
  ]
}

Updating Third-party Stickerpacks

Request

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",
}

Parameters

NameRequiredDescription

publisher

No

The name of the publisher of the third-party stickerpack

name

No

The name of the stickerpack

ios_app_store_link

No

A link to the stickerpack in the Apple iOS App Store
The link follows the format https://itunes.apple.com/app/idXXXXXXXXX
To get your App Store link, refer to the instructions at https://stackoverflow.com/questions/4137426/get-itunes-link-for-app-before-submitting

android_app_store_link

No

A link to the stickerpack in the Google Play store
The link follows the format https://play.google.com/store/apps/details?id=com.example where com.example is your app's package name

Response

A successful response will show 200 OK and either null or {}.

null or {}

Deleting Third-party Stickerpacks

Request

DELETE /v1/stickerpacks/your-sticker-pack-id

Response

A successful response will show 200 OK and either null or {}.

null or {}

Third-party Stickers

Creating Third-party Stickers

Request

POST /v1/stickerpacks/your-sticker-pack-id/stickers
{
  "image_data_id" : "your-sticker-image-media-id",
  "emojis": ["🐥", "😃"]
}

Parameters

NameRequiredDescription

image_data_id

Yes

The ID for the sticker media

emojis

No

An array of the emojis included in the stickerpack

Response

{
  "stickers": [{
    "index": "sticker-index"
  }]
}

Retrieving Third-party Stickers

Request

GET /v1/stickerpacks/your-sticker-pack-id/stickers

Response

{
  "stickers": [
    {"index": "sticker-index1"},
    {"index": "sticker-index2"}
  ]
}

Retrieving Third-party Sticker Information

Request

GET /v1/stickerpacks/your-sticker-pack-id/stickers/your-sticker-index

Response

{
  "stickers": [
    {
      "id": "sticker-media-id" # ex: b942a4d1-4e1d-4c56-8cfa-a848b8222061
      "emojis": ["🐥", "😃"],
      "image_data_id" : "sticker-image-media-id",
    }
  ]
}

Updating Third-party Stickers

Request

PATCH /v1/stickerpacks/your-sticker-pack-id/stickers/your-sticker-index
{
  "image_data_id" : "your-sticker-image-media-id",
  "emojis": ["🐥", "😃"],
}

Parameters

NameRequiredDescription

image_data_id

No

The ID for the sticker media

emojis

No

An array of the emojis included in the stickerpack

Response

A successful response will show 200 OK and either null or {}.

null or {}

Deleting Third-party Stickers

Request

DELETE /v1/stickerpacks/your-sticker-pack-id/stickers/your-sticker-index

Response

A successful response will show 200 OK and either null or {}.

null or {}