CDP REST APIAPI Reference
Unlink Profile Alias
Remove an external-id alias from a profile.
DELETE /cdp/profiles/{id}/aliases/{aliasId} removes an external-id alias from a profile.
Idempotent — unlinking an alias that is already gone still succeeds.
Every write is bound to your brand's shop scope. See Tenant Isolation & Scope.
Query parameters
| Parameter | Type | Required | Default | Description |
|---|---|---|---|---|
profileId | string | Yes | — | Path parameter ({id}) — the profile to unlink the alias from. (Not a query parameter.) |
aliasId | string | Yes | — | Path parameter ({aliasId}) — the external id to unlink. |
Response
The 200 response body:
| Field | Type | Description |
|---|---|---|
profileId | string | |
aliasId | string | |
status | 'unlinked' | |
scope | string | Your brand's resolved shop domain. |
Errors
All errors share the standard envelope { "error": string, "error_description": string }.
| Status | Code | When |
|---|---|---|
400 | invalid_property | The aliasId is empty or contains a forbidden character. |
401 | unauthorized | Missing or invalid API credential. |
403 | forbidden | No connected Shopify integration resolves a scope for the brand. |
404 | not_found | No such profile in your brand scope (missing or out-of-scope). |
405 | method_not_allowed | The request used a method other than DELETE. |
500 | internal_error | An unexpected error prevented the unlink. |