Delete an Alias Account

Use this endpoint to delete an Account Alias. By default, it performs a soft delete (logical removal). To permanently delete the record, use the hard_delete=true query parameter.

DELETE /v1/holders/{holder_id}/aliases/{alias_id}

Delete an Alias Account

cURL

curl --request DELETE \
  --url https://crm.sandbox.lerian.net/v1/holders/{holder_id}/aliases/{alias_id} \
  --header 'X-Organization-id: <x-organization-id>'

204

Example

{}

Headers

Authorization · string

The authorization token in the 'Bearer ' format.

Important: This header is required if your environment has Access Manager enabled. For more information, refer to the Access Manager documentation.

X-Organization-id · string · required

The unique identifier of the Organization associated with the request.

Example:

"019c96a0-0a98-7287-9a31-786e0809c769"

Path Parameters

holder_id · string · required

Unique identifier of the Holder.

alias_id · string · required

Unique identifier of the Alias Account.

Query Parameters

hard_delete · string

Set to true to perform a physical deletion (hard delete) of the data. This action is irreversible.

Response

204

application/json

If the request is successful, you'll get an empty response.