Create a new include version
POST https://{{host}}/papi/v1/includes/:includeId/versions
Limited availability Create a new include version based on any previous version. All data from the createFromVersion
populates the new version. Specify createFromVersionEtag
if you want to ensure you're creating from a version that hasn't changed since you fetched it.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
contractId | string | (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. | |
groupId | string | (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. | |
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
{"createFromVersion"=>1, "createFromVersionEtag"=>"2641910c585cf67b"}
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
{"versionLink":"/papi/v0/includes/inc_173136/versions/2?contractId=ctr_K-0N7RAK7\u0026groupId=grp_15225"}