Activate or deactivate an include

POST https://{{host}}/papi/v1/includes/:includeId/activations

Limited availability This operation creates a new include activation, which deactivates any current activation. After a necessary delay, this activates your version's rule tree modifying how your edge content responds to end-user requests.

Note: To reduce errors, avoid calling PAPI with separate clients on the same data. Avoid frequently polling status values. Instead, progressively increase the delay between calls.

Request Params

KeyDatatypeRequiredDescription
contractIdstring(Optional) Unique identifier for the contract. The parameter is optional if a property belongs to only one contract. Otherwise you need to specify it along with the groupId. In other operations that don't specify a propertyId URL parameter, this parameter is always required. See ID prefixes for details on omitting the value's ctr_ prefix.
groupIdstring(Optional) Unique identifier for the group. The parameter is optional if a property belongs to only one group. Otherwise you need to specify it along with the contractId. In other operations that don't specify a propertyId URL parameter, this parameter is always required. See ID prefixes for details on omitting the value's grp_ prefix.
accountSwitchKeystring(Optional) For customers who manage more than one account, this runs the operation from another account. The Identity and Access Management API provides a list of available account switch keys.

Request Body

{"acknowledgeAllWarnings"=>false, "acknowledgeWarnings"=>["msg_baa4560881774a45b5fd25f5b1eab021d7c40b4f"], "activationType"=>"ACTIVATE", "ignoreHttpErrors"=>true, "includeVersion"=>1, "network"=>"STAGING", "note"=>"Sample activation", "notifyEmails"=>["you@example.com", "them@example.com"]}

HEADERS

KeyDatatypeRequiredDescription
PAPI-Use-Prefixesstring(Required) Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.
Content-Typestring
Acceptstring

RESPONSES

status: Created

{"activationLink":"/papi/v0/includes/inc_173136/activations/93797ec9-4381-4553-b400-a4de28ab54ab?contractId=ctr_K-0N7RAK7\u0026groupId=grp_15225"}