NUTRINTG Profile API - UPDATE / ADD ELEMENT

For development purposes:

• We do not use queues, Middleware should take the message as it is and send it to Epsilon API

• The new endpoint should be set

• Epsilon endpoint: api/v1/profiles/{profileId} (rest of the params as below)

• Epsilon uses path variable in URI, here is the link on how to do it in the Mulesoft: https://help.mulesoft.com/s/question/0D52T00004mXTnDSAW/reading-path-parameter-in-http-request

• Authorization, accordingly to the PROFILE API (the same as it is now): NUTRINTG Security Integration Quick Start

When to use: in case of adding new or update an existing profile’s data

Method: PUT

Notice:

• You can update (pass in the query) only the fields that you wish to update, expect:

  • The following attributes must be submitted as part of the Update request unless the value is no longer needed:

    • Prefix

    • FirstName

    • MiddleInit

    • MiddleName

    • LastName

    • Suffix

    • LanguageCode

    • MaritalStatus

    • Gender

    • BirthDate

    • CompanyName

• In case you wish to update a specific object you need to provide a objectID, example AddressId. In case there is no Id passed, the new instance of the object will be created

• While updating email / phone, keep in mind that only one object should have value “IsPreferred”:true

• Profile status is always required to be included in the request body
  
  

Endpoint:

• Production Service URL: https://api.cdp-rb.com/profile/{profileId}

• UAT Service URL: https://api.cdp-rb.com/test/profile/{profileId}

Headers:

• all headers are mandatory:

Body:

• Example body
  
  

Response:

• Response code: 200

• Response description: OK

• Response body: The whole profile data, example:

For development purposes:

• We do not use queues, Middleware should take the message as it is and send it to Epsilon API

• The new endpoint should be set

• Epsilon endpoint: api/v1/profiles/{profileId}/subscriptions (rest of the params as below)

• Epsilon uses path variable in URI, here is the link on how to do it in the Mulesoft: https://help.mulesoft.com/s/question/0D52T00004mXTnDSAW/reading-path-parameter-in-http-request

• Authorization, accordingly to the PROFILE API (the same as it is now): NUTRINTG Security Integration Quick Start

• Part of the service “Profile service Sync”

When to use: in case of adding new or update an existing subscription

Method: PUT

Notice:

• The unique key for Subscriptions is SubscriptionID+ChannelCode (the can be three the same subscriptionIDs with various ChannelCodes

• If the updated element does not exist (SubscriptionID+ChannelCode combination does not exist), the new subscription will be added to the profile. Otherwise updated field will be updated

Endpoint:

• Production Service URL: https://api.cdp-rb.com/profile/{profileId}/subscriptions

• UAT Service URL: https://api.cdp-rb.com/test/profile/{profileId}/subscriptions

Headers:

• all headers are mandatory:

Body:

Minimum data payload for each depends on the ChannelCode:

• for: DM

• for: PH, SM

• for: EM

Response:

• Response code: 200

• Response description: OK

• Response body: Data for updated Subscription, example:

•  

For development purposes:

• We do not use queues, Middleware should take the message as it is and send it to Epsilon API

• The new endpoint should be set

• Epsilon endpoint: api/v1/profiles/{profileId}/surveys/{surveyId} (rest of the params as below)

• Epsilon uses path variable in URI, here is the link on how to do it in the Mulesoft: https://help.mulesoft.com/s/question/0D52T00004mXTnDSAW/reading-path-parameter-in-http-request

• Authorization, accordingly to the PROFILE API (the same as it is now): NUTRINTG Security Integration Quick Start

• Part of the service “Profile service Sync”

When to use: in case of adding new or update an existing survey

Method: PUT

Notice:

• If the updated element does not exist, the new survey will be added to the profile. Otherwise updated field will be updated

Endpoint:

• Production Service URL: https://api.cdp-rb.com/profile/{profileId}/survey/{surveyId}

• UAT Service URL: https://api.cdp-rb.com/test/profile/{profileId}/survey/{surveyId}

Headers:

• all headers are mandatory:

Body:

Example data payload:

Response:

• Response code: 200

• Response description: OK

• Response body: Data for updated Survey, example:

  •  

For development purposes:

• We do not use queues, Middleware should take the message as it is and send it to Epsilon API

• The new endpoint should be set

• Epsilon endpoint: api/v1/profiles/{profileId}/activities (rest of the params as below)

• Epsilon uses path variable in URI, here is the link on how to do it in the Mulesoft: https://help.mulesoft.com/s/question/0D52T00004mXTnDSAW/reading-path-parameter-in-http-request

• Authorization, accordingly to the PROFILE API (the same as it is now): NUTRINTG Security Integration Quick Start

• Part of the service “Profile service Sync”

When to use: in case of adding new Profile Activity

Method: POST

Notice:

• Only one activity can be submitted at a time (activities cannot be summited in an array); therefore, if multiple actions are taken in a single session, then multiple activities should be created so as to most accurately capture what happened in the session.

• There are many ProfileActivity types available to use, they are listed below (example: registration, subscribe

• The payload and the response vary depending on the ProfileActivity type, for detailed information about payloads for each ProfileActivity type, contact CDP TEAM

• While this web service is an individual call, it can be used within the following web services:

  • Add Profile

  • Update Profile by ID

  • Update Profile Subscription

  • Update Survey Response

• Possible ProfileActivities:

Endpoint:

• Production Service URL: https://api.cdp-rb.com/profile/{profileId}/activities

• UAT Service URL: https://api.cdp-rb.com/test/profile/{profileId}/activities

Headers:

• all headers are mandatory:

Body:

Example data payload :

Response:

• Response code: 200

• Response description: OK

• Response body: Data for added activity, example:

  •  

• Registration

• Unregistration

• Add Child

• Channel Opt-in

• Channel Opt-out

• Edit Profile

• Edit Child

• Subscribe

• Unsubscribe

• CareGiver Consumer Remove

• CareGiver/ Consumer Reinstate

• Child Remove

• Child Reinstate

• Sample Request

• Cancel Sample Request

• Fulfillment Request

• Cancel Fulfillment Request

• Social Review

• Social Request

• (take) Survey

• Promotional Web Click

• App Login

• App Login Fail

• App Photo

• App Photo Upload

• App Photo Share

• App Video Create

• App Video Share

• App Bookmark

• App Voucher Redeem

• App Product

• Signed