Update all properties of a membership.
put
/learn.rest/v1/memberships/{membershipId}
Request
Supported Media Types
- application/json
Path Parameters
-
membershipId: number
Unique identifier of Membership.
Membership object that needs to be updated.
Root Schema : MembershipRequest
Type:
object
Membership request object. This object comprises all the parameters required to create a new membership.
Show Source
-
learnCenterId:
number(int32)
Minimum Value:
178409
Maximum Value:1.0E18
Unique identifier for the LearnCenter.Example:178784
-
status:
string
Status of the membership.Example:
approved
-
userId:
number
Minimum Value:
112867
Maximum Value:1.0E18
User ID of the user being added to the membership.Example:112900
-
validFromDate(optional):
string(date-time)
The date the membership is valid from.Example:
2016-02-23T07:21:00-05:00
-
validUntilDate(optional):
string(date-time)
The date the membership is valid until.Example:
2016-02-23T07:21:00-05:00
Example:
{
"learnCenterId":178784,
"userId":112900,
"status":"approved",
"validFromDate":"2016-02-23T07:21:00-05:00",
"validUntilDate":"2016-02-23T07:21:00-05:00"
}
Security
-
auth: basic
Type:
basic
Description:Basic Authentication
Response
Supported Media Types
- application/json
200 Response
Resource updated.
400 Response
Request has incorrect syntax or does not contain a field that is required.
401 Response
404 Response
Resource not found.
422 Response
Request may contain validation errors.
500 Response
Internal server error.