Skip to main content

Update User

Update User​

This endpoint is for you to update your user’s identifier when they update their identifier on your platform.

Endpoint Put​

Path Parameter​

NameDescriptionRequiredData type
USER_REFERENCEThe user’s reference — the one returned when the user was indexed.trueString

Request Body Parameter​

NameDescriptionRequiredData type
identifierThe user’s new identifier that matches the business’s identifier type.trueString
Sample request
{
"identifier": "trojin"
}
Sample response
{
"indexed_user": {
"reference": "the-nothing-the-ghost",
"name": "Trojan Okoh",
"identifier": "trojin",
"identifier_type": "username",
"email": "trojan@thepeer.co",
"created_at": "2023-02-27T13:01:51.000000Z",
"updated_at": "2023-02-27T15:44:23.000000Z"
}
}