This endpoint handles the workflow orchestration between the integration services (such as Auth0, Gigya, SSOR, and Firefly) and Subscribe Registration API to update the email of a user based on the provided CustomerRegistrationId.
Note: The old model is in PascalCase, while the new model is in CamelCase.
URL
/User/{customerRegistrationId}
/v4/Users/{CustomerRegistrationId}/Email
Method
PUT
PATCH
Request
Response
PATCH /v4/Users/{CustomerRegistrationId}/Email
This endpoint is used to update the email of a user.
Note: The parameters marked with an asterisk (*) are mandatory and must be included in the input model.
CustomerRegistrationId*
String
Unique identifier for the user in the authentication provider
Authorization*
String
JSON Web Token used for security purposes
X-SourceSystem*
String
To identify the consumer or the Source System
X-ClientCode*
String
Client Code of the Tenant
X-PaperCode*
String
Paper Code of the Tenant
X-ClientGroupCode*
String
Client Group Code of the Tenant
Email*
String
Subscriber’s email.
400
UsersOrchestrator_E400
Bad Request
400
UsersOrchestrator_E400_00
Invalid InputModel - {Message}
400
UsersOrchestrator_E400_08
The email is already in use by another user
500
UsersOrchestrator_E500
Internal Server Error
500
UsersOrchestrator_E500_01
There was a problem during the GetById workflow.
Note:– The associated Event IDs for the Event Type Codes are specified in parentheses (i.e., EventTypeCode (EventID)) in the table below.
GETUSERBYID (1042)
AUTHSYSTEM_USER_GETBYID (4601)
SUBSCRIBE_USER_GETBYID (4001)
For each GETUSERBYID old event, we now create two events: one for the call to the third-party system and one for the call to our database.
CHGEMAIL (21)
AUTHSYSTEM_USER_CHANGEEMAIL (4610)
SUBSCRIBE_USER_CHANGEEMAIL (4011)
For each CHGEMAIL old event, we now create two events: one event is for the call to the third-party system and the other is for the call to our database.