Create User

Introduction

This endpoint handles the workflow orchestration between the integration services (such as Auth0, Gigya, SSOR, and Firefly) and Subscribe Registration API to create a user.

Comparison

Note:

1. The old model is in PascalCase, while the new model is in CamelCase.

2. Cookie tokens will not be returned by the UsersOrchestrator API.

3. For custom fields, use Metadata.

	User API	Users Orchestrator API
URL	/User	/v4/Users
Method	POST	POST
Request	{ "Email": "string", "Password": "string", "CreationMode": 0, "CustomerRegistrationId": "string", "FirstName": "string", "LastName": "string", "DisplayName": "string", "Phone": "string", "MobilePhone": "string", "DOB": "string", "BirthYear": "string", "Gender": "string", "OptInEVantageSubscriberRewards": true, "OptInSpecialOffers": true, "OptInContestAndPromotions": true, "OptInPaperlessBilling": true, "OptInEEdition": true, "OptInEEditionEmailNotification": true, "OptInSubscriberDiscounts": true, "OptInAdvertiserEmails": true, "MemberEvent": true, "ContentEngagement": true, "SUBCOM": true, "Survey": true, "AccountUpdates": true, "AcceptsEmailOffers": 0, "AcceptsEmailAds": 0, "AcceptsEmailPromotions": 0, "IsOkToEmail": 0, "IsOkToPhone": 0, "IsOkToMail": 0, "AcceptsEENotification": 0, "AcceptsTermsOfService": true, "Country": "string", "Address": "string", "City": "string", "State": "string", "ZipCode": "string", "Photo": "string", "OptOutMarketing": true, "VerifyEmail": true, "ReturnUrl": "string", "PaperCode": "string", "NewspaperId": 0, "AuthSystemId": 0, "Metadata": {} }	{ "email": "string", "customerRegistrationId": "string", "encryptedCustomerRegistrationId": "string", "password": "string", "verifyEmail": true, "returnUrl": "string", "firstName": "string", "lastName": "string", "state": "UserState", "metadata": { "title": "", "phoneNumber": "", "gender": "", "age": "", "dob": "", "dobYYYY": "", "acceptsEmailOffers": "", "acceptsEmailAds": "", "acceptsEmailPromotions": "", "address": "", "city": "", "country": "", "position": "", "isOkToEmail": "", "isOkToPhone": "", "isOkToMail": "", "workPhone": "", "timeZone": "", "scoreMember": "", "companyName": "", "postalCode": "", "cellPhone": "", "acceptsEENotification": "", "ebill_flag": "", "eadvan_flag": "", "eedition_flag": "", "ee_email_flag": "", "promo_flag": "", "feat_flag": "", "dealdigger_flag": "", "ads_flag": "", "member_event_flag": "", "contentEngagement_flag": "", "subcom_flag": "", "survey_flag": "", "accountUpdates_flag": "", "photo": "", "displayName": "", "optOutMarketing": "", "agreeToTerms": "", "bounceType": "" }, "ignoreProvider": true }
Response	{ "Code": 0, "Errors": [ { "Message": "string", "Code": "string", "Type": { "Id": 0, "Code": "string" }, "ErrorSource": "string" } ], "Result": { "CustomerRegistrationId": "string", "EncryptedCustomerRegistrationId": "string", "Mg2RegistrationId": 0, "RegistrationVerificationId": 0, "Tokens": [ { "Name": "string", "Content": "string", "CookieDurationDays": "string" } ] }, "SessionId": "string", "RequestId": "string" }	{ "message": { "code": "string", "text": "string", "type": 0 }, "meta": "string", "data": { "customerRegistrationId": "string", "encryptedCustomerRegistrationId": "string" } }

---

Create User

POST /v4/Users

This endpoint is used to create a user.

Note: The parameters marked with an asterisk (*) are mandatory and must be included in the input model.

Headers

Name	Type	Description
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

Request Body

Name	Type	Description
Email	String	Subscriber’s email.
Metadata	Object	Metadata must be an object in camelCase format.
LastName	String	Subscriber’s last name.
FirstName	String	Subscriber’s first name.
IgnoreProvider	Boolean	If the IgnoreProvider flag is false, it executes a Create operation through the ThirdParty system (Integration). If the IgnoreProvider flag is true, it executes a Create operation through the SubscribeRegistration API (Subscribe).
ReturnUrl	String	URL to which users must be redirected after they have successfully verified their registration.
VerifyEmail	Boolean	Default false. If True is provided, then the registration will not be created right away. Naviga would wait until the user confirmed the registration by clicking the link in the verification email.
Password	String	Subscriber’s password.
EncryptedCustomerRegistrationid	String	Encrypted unique identifier for the user in authentication system.
CustomerRegistrationId	String	Unique identifier for the user in the authentication provider

200

{
  "message":{
      "code": "UsersOrchestrator_S200_06",
      "text": "Create completed.",
      "type": "Success"
  },
  "data": {
      "customerRegistrationId": "string",
      "encryptedCustomerRegistrationId": "string"     
  }
}

Error Codes

Status Code	Code	Message
400	UsersOrchestrator_E400	Bad Request
400	UsersOrchestrator_E400_00	Invalid InputModel - {Message}
400	UsersOrchestrator_E400_07	The entered email address is still pending for verification.
400	UsersOrchestrator_E400_08	The email is already in use by another user.
400	UsersOrchestrator_E400_09	The metadata is invalid.
400	UsersOrchestrator_E400_17	Metadata Key or Value cannot contain more than 100 characters.
400	UsersOrchestrator_E400_23	The customer registration id already exists.
500	UsersOrchestrator_E500	Internal Server Error
500	UsersOrchestrator_E500_01	There was a problem during the GetById workflow.

Events

Note:– The associated Event IDs for the Event Type Codes are specified in parentheses (i.e., EventTypeCode (EventID)) in the table below.

Current	New	Note
GETUSER (73)	AUTHSYSTEM_USER_GET (4601)	Renamed. This event retrieves a User by Id from AuthSystem.
CREATELOGIN (68)	AUTHSYSTEM_USER_CREATE (4602) SUBSCRIBE_USER_CREATE (4002)	For each CREATELOGIN old event, we now create two events. One is for the call to the third-party system, and the other is for the call to our database. SUBSCRIBE_USER_CREATE is responsible for sending the email.