Create or clone an include
POST https://{{host}}/papi/v1/includes?contractId={{contractId}}&groupId={{groupId}}
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.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
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 | (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
{"includeName"=>"my.new.include1.com", "includeType"=>"COMMON_SETTINGS", "productId"=>"prd_Alta", "ruleFormat"=>"v2022-10-18"}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
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. | |
Content-Type | string | ||
Accept | string |
RESPONSES
status: Created
{"includeLink":"/papi/v0/includes/inc_243237?contractId=ctr_K-0N7RAK7\u0026groupId=grp_15225"}