Modify a user profile

post

https://{hostname}/entity.update

Updates a user profile.This operation only modifies attributes specified in the request. Any attributes not included in the request are left exactly as-is. Plural values are appended to an existing plural unless an ID is provided. In that case, the plural data matching the specified ID is replaced.

Form Data

created

string

Timestamp indicating when the entity (user profile) was created. If the provided value is incorrect, the call fails.

integer

Unique identifier of the user record. This member is optional if you specify the uuid member or the key_attribute member.

key_attribute

string

Name of a unique attribute in the schema. This member is required unless you use the uuid member or the id parameter. If you use key_attribute to locate a user account your operation also needs to use the key_value member. The key_attribute member specifies the attribute you're searching on and key_value specifies the value you're searching for.

key_value

string

Value assigned to the key_attribute member. The key_attribute member provides a way to locate a user account without using the id member or the uuid member. Enclose any string values in quotes.

last_updated

string

Timestamp generated the last time the user account was updated. If this value is present but incorrect, the operation fails.

type_name

string

Name of the entity type (user profile database) where the user profile is stored.

uuid

string

Unique identifier of the user record. Required unless you use the id member or the key_attribute member.

value

string

Value to assign to the attribute_name parameter. If attribute_name references just one attribute you only need to supply a value. For example, Fred. If attribute_name references multiple values then use JSON to specify each attribute value. For example, to assign values to the givenName and the familyName attributes use the syntax {"givenName":"Bob","familyName":"Smith"}.

include_record

boolean

When true, the API response includes all the attributes and attribute values assigned to the newly created or updated record. Use this member if you need to work with record immediately after it's been created or modified. If false or not specified then, because of database replication issues, you might experience a brief delay before the record appears in searches or counts. - $ref: parameters/attribute_name-2-query.yaml

Response

200Successful response