API Documentation

# Update Dependent v2.0Beta

The Update Dependent endpoint updates an existing dependent for an existing customer profile. Values supplied will be validated against a set of basic validation rules and applied to the dependent. The updated dependent will reflect immediately on the customer profile.

Note that while a customer may only add 4 dependents via self service channels, any of the added dependents may be managed via self service channels regardless of if the dependent was added by the customer or by our contact centre.

# Request

PUT /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.

# Request Body

The request body takes an UpdateDependent object which is described below.

# UpdateDependent

Name Required Type Description
firstName true string(50) The first name of the dependent.
lastName true string(50) The last name of the dependent.
birthDate true date The birth date of the dependent. The dependent must be less than 18 years of age and the birth date must not be in the future.
gender false string The gender for the customer. Must either be a valid value from the genders lookup or unspecified if the customer does not wish to specify their gender.
homeLanguage false string The home language for the customer. Must either be a valid value from the home languages lookup or unspecified.

# Sample

{
    "firstName": "Abigail",
    "lastName": "Jones",
    "birthDate": "2019-01-04T00:00:00",
    "gender": "Female",
    "homeLanguage": "English"
}

# 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 updated.",
            "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 customer profile cannot be found.
404
Not Found
When the dependent cannot be found.

← Delete Dependent →