Update User Data, Identifier, And Roles

Developing

POST

/v1/users/update

Partially update a profile, roles, or the active external identifier.

Safety boundary

An external identifier change must be sent alone. Combining it with profile or role changes returns 400 MIXED_IDENTIFIER_UPDATE_NOT_SUPPORTED. Split old clients into two requests: identifier-only first, then profile/roles after readback. This prevents an identifier rollback from undoing unrelated changes.

Identifier cleanup only reports rolled back when exactly one history record was deleted. Ambiguous cleanup returns USER_UPDATE_RECONCILIATION_REQUIRED; reconcile before retrying.

Request

Header Params

Body Params application/jsonRequired

Examples

Responses

🟢200OK

application/json

User updated successfully. Branch on the HTTP status and meta.code; do not branch on the human-readable message.

Bodyapplication/json

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🟠409

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

cURL

profileAndRolesidentifierOnly

curl --location 'https://sgtr-integration.returning.ai/apis/v1/users/update' \
--header 'Authorization;' \
--header 'Idempotency-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "identifier": {
        "type": "email",
        "value": "ada@example.com"
    },
    "updates": {
        "firstname": "Augusta",
        "roles": {
            "operation": "add",
            "values": [
                "vip"
            ]
        }
    }
}'

Response Example

200 - Success Example

{
    "meta": {
        "status": "success",
        "statusCode": 200,
        "code": "USER_UPDATED"
    },
    "message": "User updated successfully.",
    "data": {
        "userId": "3247779",
        "updated": true
    }
}

Modified at 2026-07-20 18:50:42

Get User Milestones

Update User Data, Identifier, And Roles

Safety boundary#

Request

Responses

Safety boundary