Delete a user profile

post

https://{hostname}/entity.delete

Deletes the specified user profile. Alternatively, you can use this endpoint to delete a child attribute of a plural attribute. In that case, only the child attribute is deleted and the rest of the user profile remains as-is.

Form Data

attribute_name

string

Attribute to be returned. This member returns values only for the specified attribute.

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.

Response

Language

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response