Create a subscription training key

Prev Next
Get
/CreateSubscriptionTrainingKeys

Allows you to create one or more unique subscription training keys.

Security
API Key
Header parameter nameapi_key
Query parameters
organizationId
integer (int32)

The Id of the related organization. If not supplied then the related API consumer organization Id will be used.

subscriptionProfileId
integer (int32) Required

The Id of the related subscription profile.

expirationDate
integer (int64) Required

When the subscription training key expires (in Unix epoch time).

maxKeyUses
integer (int32)

The maximum number of uses for the related subscription training key. If not supplied then only a single use will be allowed.

contentExpirationDate
integer (int64)

If supplied (in Unix epoch time) then this setting overrides the expiration date and sets the Content Availability Override checkbox.

trainingKeys
string

A comma-separated list of subscription training keys unique to the Skillable TMS. If not supplied then a set of unique training keys will be auto-created based on the numberOfKeys parameter.

numberOfKeys
integer (int32)

The number of subscription training keys to be created. If not supplied then a single training key will be created that is unique to the Skillable TMS. If the trainingKeys parameter is supplied then this parameter will be ignored.

Responses
200

OK Response

Expand All
object
Status
integer (int32)

Indicates the status of the API request.

0 = Success
10 = Error
20 = Not found
30 = Invalid integration key

Example10
Error
string | null

Error details. This will only have a value if an error was encountered. The status property will also be set to Error (10).

CreateSubscriptionsResults
Array of object (CreateSubscriptionTrainingKeyResult)

See CreateSubscriptionsResult.

object
Id
integer (int32)

The ID of the created Subscription Training Key.

Example45632
trainingKey
string

The Subscription Training Key that has been created.

ExampleE3G5YZFREFEQ9371