Merge Profiles

POST {{baseUrl}}/api/profile-merge/

Merge a given related profile into a profile with the given profile ID.

The profile provided under relationships (the source profile) will be merged into the profile provided by the ID in the base data object (the destination profile). This endpoint queues an asynchronous task which will merge data from the source profile into the destination profile, deleting the source profile in the process. This endpoint accepts only one source profile.

To learn more about how profile data is preserved or overwritten during a merge, please visit our Help Center.

Rate limits:
Burst: 10/s
Steady: 150/m

Scopes: profiles:write

Request Body

{"data"=>{"type"=>"profile-merge", "id"=>"<string>", "relationships"=>{"profiles"=>{"data"=>[{"type"=>"profile", "id"=>"<string>"}, {"type"=>"profile", "id"=>"<string>"}]}}}}

HEADERS

KeyDatatypeRequiredDescription
revisionstring(Required) API endpoint revision (format: YYYY-MM-DD[.suffix])
Content-Typestring
Acceptstring

RESPONSES

status: Created

{&quot;data&quot;:{&quot;type&quot;:&quot;profile&quot;,&quot;id&quot;:&quot;\u003cstring\u003e&quot;,&quot;links&quot;:{&quot;self&quot;:&quot;\u003curi\u003e&quot;}}}