Search
Close this search box.

< / >

APIs Campaign

11. Stop campaign En

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.
  • Limit of records that can be downloaded per consumption: 60,000 records.
  • Limit of records that can be uploaded per consumption: 10,000 records.
  • Limit of days queried in dates: 31 days.
  • Limit of result weight: 256 MB.
  • API consumption time limit: 60 seconds.
  • Concurrent consumption limit of a token: 2 simultaneous requests.
  • Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.

Request

NAME DESCRIPTION TYPE
type_campaign (URL) Campaign type. This field can accept the values “preview” or “predictive”. String
campaign_id (URL) Campaign ID. String

Response

NAME DESCRIPTION TYPE
code Response code int
error Error String
msg Description of response String
Possible response codes

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "The xxxxx campaign_id has been stopped successfully"
}
				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data