Update customer profile
PUT {{baseUrl}}/v2/customer_profiles/:integrationId?runRuleEngine=false&dry=true
Update or create a Customer Profile. This endpoint triggers the Rule Builder.
You can use this endpoint to:
Set attributes on the given customer profile. Ensure you create the attributes in the Campaign Manager, first.
Modify the audience the customer profile is a member of.
Performance tips
Updating a customer profile returns a response with the requested integration state.
You can use the
responseContent
property to save yourself extra API calls. For example, you can get the customer profile details directly without extra requests.We recommend sending requests sequentially. See Managing parallel requests.
Request Params
Key | Datatype | Required | Description |
---|---|---|---|
runRuleEngine | boolean | Indicates whether to run the Rule Engine. |
If true
, the response includes:
- The effects generated by the triggered campaigns are returned in the
effects
property. - The created coupons and referral objects.
If false
:
- The rules are not executed and the
effects
property is always empty. - The response time improves.
- You cannot use
responseContent
in the body. | |dry
| boolean | | (Only works whenrunRuleEngine=true
) Indicates whether to persist the changes. Changes are ignored whendry=true
.
When set to true
, you can use the evaluableCampaignIds
body property to select specific campaigns to run.
|
Request Body
{"attributes"=>{"Language"=>"english", "ShippingCountry"=>"DE"}, "evaluableCampaignIds"=>[10, 12], "audiencesChanges"=>{"adds"=>[2, 4], "deletes"=>[7]}, "responseContent"=>["triggeredCampaigns", "customerProfile"]}
HEADERS
Key | Datatype | Required | Description |
---|---|---|---|
Content-Type | string | ||
Accept | string |