• Enrollment Keys
  • getGet enrollment key.
  • postUpdate enrollment key.
  • getGet enrollment key by external ID.
  • postCreate enrollment key.

API docs by Redocly

Absorb Integration API (v2)

Download OpenAPI specification:Download

Enrollment Keys

Get enrollment key.

Authorizations:

api_key

path Parameters

enrollmentKeyId required

string <guid> The ID of the enrollment key.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> The unique enrollment key identifier.
name	string The enrollment key's name.
keyName	string The enrollment key's key name.
departmentId	string <guid> The enrollment key's department ID.
usernameType	integer Enum: 0 1 2 The enrollment key's username type. Possible Enum Values: 0 = UserInput 1 = Email 2 = FirstNameLastName
maxUses	integer <int32> The enrollment key's max uses.
timesUsed	integer <int32> The enrollment key's times used.
dateAdded	string The enrollment key's date added.
dateEdited	string The enrollment key's date edited.
startDate	string The enrollment key's start date. If not set, the key is immediately redeemable.
expiryDate	string The enrollment key's expiry date. If not set, the key never expires.
languageId	integer <int32> The enrollment key's language ID.
sendNewUserMessageOnEnrollment	boolean True if a new user message will be sent upon enrollment, false otherwise.
externalId	string The enrollment key's external ID.
	Array of objects (EnrollmentKeyCourseResource) The enrollment key's courses.
	Array of objects (SignupFieldResource) The enrollment key's signup fields.

US

https://rest.myabsorb.com/enrollment-keys/{enrollmentKeyId}

CA

https://rest.myabsorb.ca/enrollment-keys/{enrollmentKeyId}

EU

https://rest.myabsorb.eu/enrollment-keys/{enrollmentKeyId}

AU

https://rest.myabsorb.com.au/enrollment-keys/{enrollmentKeyId}

Response samples

• 200
• 404

Content type

application/json

{

• "id": "string",
• "name": "string",
• "keyName": "string",
• "departmentId": "string",
• "usernameType": 0,
• "maxUses": 0,
• "timesUsed": 0,
• "dateAdded": "string",
• "dateEdited": "string",
• "startDate": "string",
• "expiryDate": "string",
• "languageId": 0,
• "sendNewUserMessageOnEnrollment": true,
• "externalId": "string",
• "courses": [

  • {

    • "courseId": "string",
    • "sessionId": "string",
    • "courseCollectionId": "string"

    }

  ],
• "signupFields": [

  • {

    • "customFieldDefinitionId": "string",
    • "name": "string",
    • "behavior": 0,
    • "isBehaviorChangeable": true,
    • "type": 0,
    • "defaultValue": "string"

    }

  ]

}

Update enrollment key.

Authorizations:

api_key

path Parameters

enrollmentKeyId required

string <guid> The ID of the enrollment key.

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

The body for the enrollment key data.

name	string Key name, only visible to admins and meant to be used for easy identification.
keyName	string The unique key name that will be entered by a user to redeem this enrollment key.
departmentId	string <guid> New accounts created with this key will be created in this department.
usernameType	integer Enum: 0 1 2 The key will create a username for the new user based on this selection. Possible Enum Values: 0 = UserInput 1 = Email 2 = FirstNameLastName
maxUses	integer <int32> Maximum times the enrollment key can be used. If you do not send this value or send null for this value the key will have unlimited uses.
startDate	string The enrollment key will not be redeemable until this date. If not set, the key is immediately redeemable.
expiryDate	string The enrollment key will not be redeemable after this date. If not set, the key never expires.
languageId	integer <int32> The number of the language to be used in the Enrollment Key instructions email. Will default to 1 (English) if not provided.
sendNewUserMessageOnEnrollment	boolean Should a user creating a new account using this enrollment key receive a welcome email? Default is false.
externalId	string Externally provided identifier for this enrollment key.
	Array of objects (EnrollmentKeyCourseRequest) The courses the user will be enrolled into upon redemption of this enrollment key.
	Array of objects (UpdateSignupFieldRequest) Overrides for the fields the user can fill in to create their new account when using this enrollment key. The defaults are set on the client and will always be used, but these fields allow some of those behaviours to be overridden.

Responses

US

https://rest.myabsorb.com/enrollment-keys/{enrollmentKeyId}

CA

https://rest.myabsorb.ca/enrollment-keys/{enrollmentKeyId}

EU

https://rest.myabsorb.eu/enrollment-keys/{enrollmentKeyId}

AU

https://rest.myabsorb.com.au/enrollment-keys/{enrollmentKeyId}

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "keyName": "string",
• "departmentId": "string",
• "usernameType": 0,
• "maxUses": 0,
• "startDate": "string",
• "expiryDate": "string",
• "languageId": 0,
• "sendNewUserMessageOnEnrollment": true,
• "externalId": "string",
• "courses": [

  • {

    • "courseId": "string",
    • "sessionId": "string",
    • "courseCollectionId": "string"

    }

  ],
• "signupFields": [

  • {

    • "customFieldDefinitionId": "string",
    • "name": "string",
    • "behavior": 0,
    • "defaultValue": "string"

    }

  ]

}

Response samples

• 404
• 422

Content type

application/json

{

• "validations": [

  • "string"

  ],
• "code": 0,
• "message": "string",
• "term": "string",
• "_meta": {

  • "property1": "string",
  • "property2": "string"

  }

}

Get enrollment key by external ID.

Authorizations:

api_key

query Parameters

externalId required

string The ID of the enrollment key.

header Parameters

x-api-key	string
x-api-version	string 2

Responses

Response Schema: application/json

id	string <guid> The unique enrollment key identifier.
name	string The enrollment key's name.
keyName	string The enrollment key's key name.
departmentId	string <guid> The enrollment key's department ID.
usernameType	integer Enum: 0 1 2 The enrollment key's username type. Possible Enum Values: 0 = UserInput 1 = Email 2 = FirstNameLastName
maxUses	integer <int32> The enrollment key's max uses.
timesUsed	integer <int32> The enrollment key's times used.
dateAdded	string The enrollment key's date added.
dateEdited	string The enrollment key's date edited.
startDate	string The enrollment key's start date. If not set, the key is immediately redeemable.
expiryDate	string The enrollment key's expiry date. If not set, the key never expires.
languageId	integer <int32> The enrollment key's language ID.
sendNewUserMessageOnEnrollment	boolean True if a new user message will be sent upon enrollment, false otherwise.
externalId	string The enrollment key's external ID.
	Array of objects (EnrollmentKeyCourseResource) The enrollment key's courses.
	Array of objects (SignupFieldResource) The enrollment key's signup fields.

US

https://rest.myabsorb.com/enrollment-keys

CA

https://rest.myabsorb.ca/enrollment-keys

EU

https://rest.myabsorb.eu/enrollment-keys

AU

https://rest.myabsorb.com.au/enrollment-keys

Response samples

• 200
• 404
• 422

Content type

application/json

{

• "id": "string",
• "name": "string",
• "keyName": "string",
• "departmentId": "string",
• "usernameType": 0,
• "maxUses": 0,
• "timesUsed": 0,
• "dateAdded": "string",
• "dateEdited": "string",
• "startDate": "string",
• "expiryDate": "string",
• "languageId": 0,
• "sendNewUserMessageOnEnrollment": true,
• "externalId": "string",
• "courses": [

  • {

    • "courseId": "string",
    • "sessionId": "string",
    • "courseCollectionId": "string"

    }

  ],
• "signupFields": [

  • {

    • "customFieldDefinitionId": "string",
    • "name": "string",
    • "behavior": 0,
    • "isBehaviorChangeable": true,
    • "type": 0,
    • "defaultValue": "string"

    }

  ]

}

Create enrollment key.

Authorizations:

api_key

header Parameters

x-api-key	string
x-api-version	string 2

Request Body schema: application/json

Request to create a new enrollment key.

name required	string non-empty Key name, only visible to admins and meant to be used for easy identification.
keyName required	string non-empty The unique key name that will be entered by a user to redeem this enrollment key.
departmentId	string <guid> New accounts created with this key will be created in this department. If not specified, the top-level department for the authenticated user will be used.
usernameType	integer Enum: 0 1 2 Specifies how usernames will be generated when new accounts are created using this enrollment key. If not specified, the Email type will be used. Possible Enum Values: 0 = UserInput 1 = Email 2 = FirstNameLastName
maxUses	integer <int32> Maximum times the enrollment key can be used. If you do not send this value or send null for this value the key will have unlimited uses.
startDate	string The enrollment key will not be redeemable until this date. If not set, the key is immediately redeemable.
expiryDate	string The enrollment key will not be redeemable after this date. If not set, the key never expires.
languageId	integer <int32> The number of the language to be used in the Enrollment Key instructions email. Will default to 1 (English) if not provided.
sendNewUserMessageOnEnrollment	boolean Should a user creating a new account using this enrollment key receive a welcome email? Default is false.
externalId	string [ 0 .. 255 ] characters When specified, associates the enrollment key with an externally provide identifier.
	Array of objects (EnrollmentKeyCourseRequest) The courses the user will be enrolled into upon redemption of this enrollment key.
	Array of objects (CreateSignupFieldRequest) Overrides for the fields the user can fill in to create their new account when using this enrollment key. The defaults are set on the client and will always be used, but these fields allow some of those behaviours to be overridden.

Responses

Response Schema: application/json

id	string <guid> The unique enrollment key identifier.
name	string The enrollment key's name.
keyName	string The enrollment key's key name.
departmentId	string <guid> The enrollment key's department ID.
usernameType	integer Enum: 0 1 2 The enrollment key's username type. Possible Enum Values: 0 = UserInput 1 = Email 2 = FirstNameLastName
maxUses	integer <int32> The enrollment key's max uses.
timesUsed	integer <int32> The enrollment key's times used.
dateAdded	string The enrollment key's date added.
dateEdited	string The enrollment key's date edited.
startDate	string The enrollment key's start date. If not set, the key is immediately redeemable.
expiryDate	string The enrollment key's expiry date. If not set, the key never expires.
languageId	integer <int32> The enrollment key's language ID.
sendNewUserMessageOnEnrollment	boolean True if a new user message will be sent upon enrollment, false otherwise.
externalId	string The enrollment key's external ID.
	Array of objects (EnrollmentKeyCourseResource) The enrollment key's courses.
	Array of objects (SignupFieldResource) The enrollment key's signup fields.

US

https://rest.myabsorb.com/enrollment-keys

CA

https://rest.myabsorb.ca/enrollment-keys

EU

https://rest.myabsorb.eu/enrollment-keys

AU

https://rest.myabsorb.com.au/enrollment-keys

Request samples

• Payload

Content type

application/json

{

• "name": "string",
• "keyName": "string",
• "departmentId": "string",
• "usernameType": 0,
• "maxUses": 0,
• "startDate": "string",
• "expiryDate": "string",
• "languageId": 0,
• "sendNewUserMessageOnEnrollment": true,
• "externalId": "string",
• "courses": [

  • {

    • "courseId": "string",
    • "sessionId": "string",
    • "courseCollectionId": "string"

    }

  ],
• "signupFields": [

  • {

    • "customFieldDefinitionId": "string",
    • "name": "string",
    • "behavior": 0,
    • "defaultValue": "string"

    }

  ]

}

Response samples

• 201
• 422

Content type

application/json

{

• "id": "string",
• "name": "string",
• "keyName": "string",
• "departmentId": "string",
• "usernameType": 0,
• "maxUses": 0,
• "timesUsed": 0,
• "dateAdded": "string",
• "dateEdited": "string",
• "startDate": "string",
• "expiryDate": "string",
• "languageId": 0,
• "sendNewUserMessageOnEnrollment": true,
• "externalId": "string",
• "courses": [

  • {

    • "courseId": "string",
    • "sessionId": "string",
    • "courseCollectionId": "string"

    }

  ],
• "signupFields": [

  • {

    • "customFieldDefinitionId": "string",
    • "name": "string",
    • "behavior": 0,
    • "isBehaviorChangeable": true,
    • "type": 0,
    • "defaultValue": "string"

    }

  ]

}