Speaking Partners Platform API
Packages

Package

Get Package Code
Retrieves the details for a specific package code. May also include student details if the code has been assigned.
GET https://api.speaking-partner.com/v1/packagecodes/{code}

URL Parameters

Name Required? Description
Code Yes The package code generated and provided by Speaking Partners.

Example Request

GET: https://api.speaking-partner.com/v1/packagecodes/BBBB-2222-2222-4444

Example Response

{
   "AssignedDate":null,
   "Code":"BBBB-2222-1111-4444",
   "PackageId":10,
   "RedeemedDate":null,
   "Status":"Active",
   "Student":null
}
Update Package Code
Updates a previously generated package code. Responds with the package code and student information if it has been assigned.
POST https://api.speaking-partner.com/v1/packagecodes/{code}

URL Parameters

Name Required? Description
Code Yes The package code generated and provided by Speaking Partners.

Request Parameters

Name Required? Description
Status No The new status of the package code. Can be active or inactive.
Redeemed No Indicates whether to redeem the package code.

Example Request

POST: https://api.speaking-partner.com/v1/packagecodes/BBBB-2222-2222-4444
BODY: status=inactive

Example Response

{
   "AssignedDate":null,
   "Code":"BBBB-2222-2222-4444",
   "PackageId":55,
   "RedeemedDate":null,
   "Status":"Inactive",
   "Student":null
}