We are sunsetting On-Premises API. Refer to our On-Premises API Sunset document for details, and to learn how to migrate to our next-generation Cloud API.

Stickerpack Management

/v1/stickerpacks

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

Edges

The following edges are connected to this node:

EdgeDescription

/{stickerpack-id}

Use to retrieve, update, delete a specific stickerpack.

/{sticker-pack-id}/sticker

Use this endpoint to retrieve stickers and sticker information. Additionally, use this edge to create, update, and delete third-party stickers.

Retrieving

First-Party Stickerpacks

GET /v1/stickerpacks?namespace=whatsapp

The response looks like this:

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

Third-Party Stickerpacks

GET /v1/stickerpacks

The response looks like this:

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

Creating

Third-party Stickerpacks

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

A successful response looks like this:

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

Parameters

NameDescription

publisher

Required.

The name of the publisher of the third-party stickerpack.

name

Required.

The name of the stickerpack.

ios_app_store_link

Optional.

The 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

Optional.

The 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.