URL:
https://wv{{wolkvox_server}}.wolkvox.com/api/v2/campaign.php?api=stop&type_campaign={{type_campaign}}&campaign_id={{campaign_id}}
Description:
This API allows you to pause a campaign from an external platform.
Benefit:
This function is used to facilitate and speed up the process of activating or deactivating campaigns using a button, for example, from the platform where the management is being carried out.
How it works:
- The consumption of this API is done by PUT method.
- To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
- The wolkvox-token header must be used to make use of the authorization token.
- Note that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed when the result of the previous one is successful.
| REQUEST |
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| type_campaign (URL) | Phone number to add String | String |
| campaign_id (URL) | Days for which the number will be blocked | String |
| RESPONSE |
| NAME | DESCRIPTION | TYPE |
|---|---|---|
| code | Response code | int |
| error | Error | String |
| msg | Description of response | String |