Create a key collection

post

https://{hostname}/apikey-manager-api/v2/collections

Creates an empty collection under the selected contract and group.

Query Params

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

Contains information about a collection to create.

collectionDescription

string | null

Description for the collection. If you specify an empty string in the request or omit this member from the object, the JSON response reflects it as null.

collectionName

string

required

length between 1 and 200

Name of the collection.

contractId

string

required

length ≥ 1

Identifies the contract you assign to the new collection. To get this value, run the List contracts operation in the Property Manager API.

groupId

int64

required

≥ 0

Identifies the group where to create the new collection. To get this value, run the List groups operation in the Property Manager API.

Headers

string

enum

Defaults to application/json

Generated from available response content types

Allowed:

Responses

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

application/problem+json

201The response provides the newly created collection.

400Bad request. The request contains invalid data.

401Unauthorized. You are not authorized to perform the action.

403Forbidden. You don't have permission to the resource.

405Method not allowed.

500Internal server error.