Create a new include version

post

https://{hostname}/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.

Path Params

includeId

string

required

Unique identifier for the include. See ID prefixes for details on omitting the value's inc_ prefix.

Query Params

contractId

string

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

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

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

When incrementing a new version, this POST object's members aren't reflected in subsequent responses.

createFromVersion

integer

required

≥ 1

The include version on which to base the new version.

createFromVersionEtag

string

The data digest of the version on which to base the new version. See Concurrency control for guidance.

Headers

PAPI-Use-Prefixes

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

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

400Bad request.

401Unauthorized.

403Forbidden.

404Not found.

405Method not allowed.

406Not acceptable.

415Unsupported media type.

429Too many requests.

500Internal server error.