Get EnterpriseOpen Dashboard

Identities

Edit identity

Update the fields stored on an identity.

PUT/identities/{identity_id}

Authorization

If set, the API uses an API key for authentication. Include the following header in your requests: X-blnk-key: <api-key>.

Replace <api-key> with your secret API key. Ensure the key is kept secure and not exposed in public repositories or client-side code.

See also: Core API key.

Send only the fields you want to change. Blnk skips an empty string, so the stored value stays, and a body with no fields returns 400. When you send meta_data, Blnk merges those keys into the stored object and keeps tokenized_fields.

Path

identity_idstringrequiredpath

Id of the identity to update.

Body

identity_typestringbody

individual or organization.

organization_namestringbody

Name of the organization.

first_namestringbody

First name of the individual.

last_namestringbody

Last name of the individual.

other_namesstringbody

Other names linked to the individual.

genderstringbody

Gender of the individual.

dobstringbody

Date of birth, as an ISO 8601 timestamp.

email_addressstringbody

Email address of the identity.

phone_numberstringbody

Contact number of the identity.

nationalitystringbody

Nationality of the individual.

categorystringbody

A label for this customer, such as customer or vip.

streetstringbody

Street address of the identity.

countrystringbody

Country of the identity.

statestringbody

State or region of the identity.

post_codestringbody

Postal code of the identity.

citystringbody

City of the identity.

meta_dataobjectbody

Custom metadata. Keys you send are merged into the stored object. Blnk keeps tokenized_fields, and a client cannot set or clear it.

Response

messagestringrequired

Confirms the identity was updated.