API to enable BSUID flag for an app
This document describes the Partner Portal API that updates Business Scoped User ID (BSUID) flags on a WhatsApp app’s configuration on v2 or/and v3 subscriptions. You can enable eithter 1 or both subscriptions thorugh this API.
If you want to enable BSUID for v2 incoming messages and webhooks, pass enableBSUID": true
If you want to enable BSUID for v3 incoming messages and webhooks, pass enableBSUIDV3": true
You can even pass both for setting both to true.
Once enabled, all incoming DLR and message webhooks will be passed to your respective subscription including the BSUID of the user along with phone number, wherever it is received from Meta. This is applicable only for events coming post the flag is enabled.
You can also disable the flag by passing enableBSUID or enableBSUIDV3 : false
Rate limit: 10 requests per 60 seconds per route
Request example
curl --location --request PUT 'https://partner.gupshup.io/partner/app/[APP_ID]/config/bsuid'
--header 'Authorization: Bearer [PARTNER_APP_JWT]'
--header 'Content-Type: application/json'
--data '[ "enableBSUID": true, "enableBSUIDV3": true ]
Set only one flag if needed:
curl --location --request PUT 'https://partner.gupshup.io/partner/app/[APP_ID]/config/bsuid'
--header 'Authorization: Bearer [PARTNER_APP_JWT]'
--header 'Content-Type: application/json'
--data '[ "enableBSUIDV3": true ]
Response example
Response
[ "status": "success" ]
Example – missing both flags (400):
[ "status": "error", "message": "At least one of enableBSUID or enableBSUIDV3 must be provided" ]
Updated 1 day ago