Get
/UpdateClubMembership
Allows you to update a subscription assignment.
Security
API Key
Header parameter nameapi_key
Query parameters
id
integer (int32) Required
The ID of the subscription
externalId
string
The exernal ID of the subscription, usually a unique identifier from the calling system
clubId
integer (int32) Required
The Id of the related subscription profile
userId
integer (int32) Required
The Id of the related user
starts
integer (int64) Required
When the subscription starts (in Unix epoch time)
expires
integer (int64)
When the subscription expires (in Unix epoch time)
targetCompletion
integer (int64)
When the subscription is expected to be completed by the student (in Unix epoch time)
Responses
200
OK Response
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).