Hide/Recover My Sticker Pack
The Hide/Recover My Sticker Pack API allows for the user to hide or recover any sticker packages from the user’s my sticker list. This API can be used within the edit feature of my sticker list. In the case of free stickers ‘Hide’ feature can be used as a ‘Delete’ function, but for a purchased sticker the sticker can only be ‘Hidden’ from my stickers list and later be restored without any additional purchase.
Check the UI Kit to get more understanding of how this API can be used.
Request URL
PUT
https://messenger.stipop.io/v1/mysticker/hide/:userId/:packageId
Best Practices
- Check all the components that can be put into building this from our UI Kit. It will help you build the sticker feature much quicker and easier.
- For the userId parameter, please don't use identical userId for multiple users. This is thoroughly monitored and in case of any misuse, the API key can be blocked from usage. The userId can be in any string format.
- We recommend you using this along with My Sticker Packs API and Hidden Sticker Packs API to provide the best user experience to the users.
Parameters
Required | Type | Description |
---|---|---|
apikey | string | Stipop API Key for your app. Visit developer dashboard for new API Key. |
Required | Type | Description |
---|---|---|
userId | string | Unique value for every user to distinguish unique users. The userId can be in any string format. Important: Using same userId for multiple users is not allowed. |
packId | string | The [packId] of a sticker pack, NOT stickerId. Example: 6363, 5636, 5859 |
Example Request
Sample Call: Hide/Recover My Pack
cURL
1
curl --location --request PUT "https://messenger.stipop.io/v1/mysticker/hide/9937/118" --header "apikey:xxxxxxxxx"
Success Response
Success Response code 200
1
2
3
4
5
6
7
8
{
"header": {
"code": "0000",
"status": "success",
"message": "success"
},
"body": []
}
Error Response
Error | Code | Description |
---|---|---|
non exist apikey | 9000 | The API key used does not exist |
server error | 1000 | Unable to receive data from the server |
Was this page helpful?
We’re here to help. Contact us.