Create or clone an include

Limited availability This operation either creates a new include from scratch or bases one on another include's rule tree. Version 1 of a new include is created automatically.

Query Params
string
required

Unique identifier for the contract. See ID prefixes for details on omitting the value's ctr_ prefix.

string
required

Unique identifier for the group. See ID prefixes for details on omitting the value's grp_ prefix.

string

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.

Body Params
cloneFrom
object | null

Optionally identifies another include instance to clone when making a POST request to create a new include. You need to assign the same contract and group to the cloned include.

string
required

A unique, descriptive name for the include. It's not modifiable after you initially create it on a POST request.

string
enum
required

The type of an include. MICROSERVICES specifies includes with a separate access control and activation flow, which allows different teams to work independently on different parts of a single site. In a parent property's rule tree, you add the MICROSERVICES includes to rules with mutually exclusive path matches. COMMON_SETTINGS specifies includes used across different properties that share a significant number of settings. In a parent property's rule tree, you add the COMMON_SETTINGS includes to the default rule or rules without any matches. By updating or activating a single COMMON_SETTINGS include, the changes take effect immediately across all sites that use this include. You can use this member for filtering and grouping similar includes together.

Allowed:
string
required

Unique identifier for the product. See ID prefixes for details on omitting the value's prd_ prefix.

string | null

On GET, reflects the include's current format. Otherwise on POST, assigns a specific rule format to the include. Ignored on PUT, since you need to modify the Content-Type to change rule formats. For details, see Update rules to a newer set of features.

Headers
string
enum
required

Enum Sets whether to represent ID prefixes in response data. Set to false when exchanging PAPI data with other APIs.

Allowed:
string
enum
Defaults to application/json

Generated from available response content types

Allowed:
Responses

Language
URL
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json
application/problem+json