Create or clone an include

post https://{hostname}/papi/v1/includes

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.

Recipes

Create an include

Open Recipe

Clone an include

Open Recipe

Query Params

contractId

string

required

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

groupId

string

required

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

accountSwitchKey

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.

includeName

string

required

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

includeType

string

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.

productId

string

required

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

ruleFormat

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

PAPI-Use-Prefixes

string

required

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

Responses

Response body

object

includeLink

string

required

Links the newly created include.

Headers

object

Location

string

Provides a URL path you can GET the newly created resource from.

X-Limit-Includes-Per-Contract-Limit

string

Maximum number of includes per contract.

X-Limit-Includes-Per-Contract-Remaining

string

Remaining number of includes per contract. See Rate and resource limiting for details.

X-RateLimit-Limit

integer

Maximum sustainable number of request allowed each minute per account. This rate limit protects PAPI resources from being exhausted by single users. Once you exceed the limit, you receive the 429 error. If you call PAPI using multiple API clients within the same account, the rate limit applies globally to all API clients.

This API also provides a burst limit that specifies how many requests you can make in excess of the imposed rate limit. The one-time burst limit is 1000 requests. Once you consume all available resources, the burst capacity increases steadily by 100 requests every minute, until it reaches its initial maximum limit of 1000.

X-RateLimit-Remaining

integer

Remianing number of requests allowed each minute per account. See Rate and resource limiting for details.

Language

Authentication

Remember to add your authentication credentials to run this code.

URL


xxxxxxxxxx
10
1
curl --request POST \
2
     --url https://hostname/papi/v1/includes \
# Add Authorization header to this snippet
3
     --header 'PAPI-Use-Prefixes: true' \
4
     --header 'accept: application/json' \
5
     --header 'content-type: application/json' \
6
     --data '
7
{
8
  "includeType": "COMMON_SETTINGS"
9
}
10
'


xxxxxxxxxx
 
1
{
2
  "includeLink": "/papi/v0/includes/inc_243237?contractId=ctr_K-0N7RAK7&groupId=grp_15225"
3
}

201The response provides a URL link to the newly created or cloned include.

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

415Unsupported media type.

429Too many requests.

500Internal server error.