Update User

Introduction

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

Comparison

Note:

The old model is in PascalCase, while the new model is in CamelCase.
Cookie tokens will not be returned by the UsersOrchestrator API.
For custom fields, use Metadata.

User API

Users Orchestrator API

URL

/User/{customerRegistrationId}

/v4/Users/{customerRegistrationId}/

Method

PUT

Request

{
  "Email": "string",
  "AccountNumber": "string",
  "OldPassword": "string",
  "Password": "string",
  "Mode": 0,
  "CustomerRegistrationId": "string",
  "CustomerRegistrationIdNew": "string",
  "FirstName": "string",
  "LastName": "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,
  "IsActive": 0,
  "SubscriptionId": 0,
  "DisplayName": "string",
  "Country": "string",
  "Address": "string",
  "City": "string",
  "State": "string",
  "ZipCode": "string",
  "Photo": "string",
  "OptOutMarketing": true,
  "AcceptsTermsOfService": true,
  "LastLogoutDate": "2023-06-06T17:24:47.113Z",
  "EncryptedCustomerRegistrationId": "string",
  "Metadata": {}
}

{
    "verified": true,
    "lastLogoutDate": "2023-06-06T17:37:24.499Z",
    "removeLastLogoutDate": true,
    "firstName": "string",
    "lastName": "string",
    "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",
    "Updated": true
  },
  "SessionId": "string",
  "RequestId": "string"
}

{
  "message": {
    "code": "string",
    "text": "string",
    "type": 0
  },
  "meta": "string"
}

Update User

PUT /v4/Users/{customerRegistrationId}/

This endpoint is used to update a user.

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

Path Parameters

Name

Type

Description

CustomerRegistrationId*

String

Unique identifier for the user in the authentication provider

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

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).

Verified

Boolean

Indicates whether the user has confirmed the registration.

LastLogoutDate

DateTime

Subscriber’s last logout date in the Naviga platform.

RemoveLastLogoutDate

Boolean

Indicates whether to remove the Subscriber’s last logout date.

{
  "message":{
      "code": "UsersOrchestrator_S200_07",
      "text": "Update completed.",
      "type": "Success"
  },
  meta: null
}

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

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.

UPDATEUSER (712)

AUTHSYSTEM_USER_CREATE (4602)
SUBSCRIBE_USER_CREATE (4002)

For each UPDATEUSER old event, we now create two events: one for the call to the third-party system and one for the call to our database.

PreviousCreate Passwordless User NextUpdate Password

Last updated 4 months ago