Campaign API

Business Messenger (BM) Campaign API is a standard REST HTTP API with JSON payload. It can be used to programmatically manage BM campaign data. BM API authorization is implemented as the industry-standard OAuth2 protocol.

All endpoints are grouped under the single Campaign resource, reachable at https://api{separator}{platform_domain}/news/v1/services/{serviceUuid}/campaigns. It exposes operations to create or clone a campaign, list campaigns, fetch a campaign by UUID, update a campaign, toggle its status between active and stopped, and delete a campaign.

Access uses the OAuth2 client credentials grant type: a server-side app is registered with an authorized IP address, which yields a client_id and client_secret. Those are exchanged for a bearer access token that authorizes each API call and expires after a defined lifetime.