Sign in

v1

latestOpenAPI 3.0.0Apache 2.0 License2026-07-1438230222.0 KB

Updates the properties of a profile. The ProfileId is required for updating a customer profile.

When calling the UpdateProfile API, specifying an empty string value means that any existing value will be removed. Not specifying a string value means that any value already there will be kept.

put/domains/{DomainName}/profiles

Path parameters

DomainNamestring required

The unique name of the domain.

Request body

ProfileIdstring required

The unique identifier of a customer profile.

AdditionalInformationstring

Any additional information relevant to the customer’s profile.

AccountNumberstring

A unique account number that you have given to the customer.

PartyType'INDIVIDUAL' | 'BUSINESS' | 'OTHER'

The type of profile used to describe the customer.

BusinessNamestring

The name of the customer’s business.

FirstNamestring

The customer’s first name.

MiddleNamestring

The customer’s middle name.

LastNamestring

The customer’s last name.

BirthDatestring

The customer’s birth date.

Gender'MALE' | 'FEMALE' | 'UNSPECIFIED'

The gender with which the customer identifies.

PhoneNumberstring

The customer’s phone number, which has not been specified as a mobile, home, or business number.

MobilePhoneNumberstring

The customer’s mobile phone number.

HomePhoneNumberstring

The customer’s home phone number.

BusinessPhoneNumberstring

The customer’s business phone number.

EmailAddressstring

The customer’s email address, which has not been specified as a personal or business address.

PersonalEmailAddressstring

The customer’s personal email address.

BusinessEmailAddressstring

The customer’s business email address.

Attributesobject

A key value pair of attributes of a customer profile.

PartyTypeStringstring

An alternative to <code>PartyType</code> which accepts any string as input.

GenderStringstring

An alternative to <code>Gender</code> which accepts any string as input.

Response

Success

ProfileIdstring required

The unique identifier of a customer profile.