Delete Dependent v2.0Beta

The Delete Dependent endpoint deletes a dependent from a customer profile. The dependent will immediately be removed from the customer profile.

Request

DELETE /v2.0/customers/{profileKey}/dependents/{key}

Authorization

An OAuth 2.0 Bearer token with the Profile.Write scope is required. For more information, see Authentication.

Path Parameters

A list of the supported path parameters is described below.

Name	Required	Type	Description
profileKey	true	guid	The profile key for the customer. This value can be retrieved from the profileKey claim in the token returned from our SSO solution.
key	true	guid	The key for the dependent.

Response

200

OK

Returns an ApiResponse envelope.

Response Body

The endpoint returns our ApiResponse envelope.

Sample

{
    "message": "The operation succeeded!",
    "notifications": [
        {
            "severity": "Success",
            "text": "The dependent was deleted.",
            "code": null,
            "additionalData": null
        }
    ]
}

Errors

The standard error responses apply.

400

Bad Request

When the request fails validation.

401

Unauthorized

When authentication fails.

403

Forbidden

When authorisation fails.

404

Not Found

When the dependent cannot be found.