KAkalixa

Update User Enrollment Operation

Update User Enrollment Operation

post/userEnrollments/{enrollmentId}/operations

Request

  • Base URL
    https://api.test.kalixa.com/api/v5
  • URL
    https://api.test.kalixa.com/api/v5/userEnrollments/{enrollmentId}/operations
  • Auth
    none declared

Path parameters

enrollmentIdstring required

The id of the user enrollment in Kalixa system

Request body

merchantIdstring required

MerchantID in Kalixa system

clientSystemUserEnrollmentIdstring required

UserEnrollmentID in the client system

typestring required

Type of the operation that should be executed on Enrollment. Eg. MoveToEnrolled or MoveToEnrollmentFailed

userIdstring required

External User ID

detailsobject

Additional details for the User Enrollment

Example request

{
  "merchantId": "companyXY",
  "clientSystemUserEnrollmentId": "enrollment123",
  "type": "MoveToEnrolled",
  "userId": 5678432
}

Response

Successful operation

idstring

The server generated ID of the user Enrollment

statestring

Name of the last state

Example response

{
  "id": "userEnrollmentID",
  "state": "Enrolled"
}

Changes

No recorded changes to this operation across all 1 revision of this API.