API ReferenceReference
Update an end user
Update profile fields. To add plans or grants, re-POST /end-users (idempotent); to remove them, use the tier-plans and grants sub-resources.
Requires the end_users:write scope.
Authorization
apiKey AuthorizationBearer <token>
An organization API key, created from a Storefront's Webhooks page (Provisioning API card). The secret is shown once at creation and stored only as a hash. Keys are organization-wide and carry scopes (end_users:read, end_users:write). Rate limit: 120 requests per minute per key (sliding 60-second window).
In: header
Path Parameters
endUserId*string
Format
uuidRequest Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X PATCH "https://example.com/end-users/497f6eca-6276-4993-bfeb-53cbbbba6f08" \ -H "Content-Type: application/json" \ -d '{}'{ "endUser": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "user@example.com", "fullName": "string", "authMethod": "string", "emailVerifiedAt": "2019-08-24T14:15:22Z", "revokedAt": "2019-08-24T14:15:22Z", "lastSeenAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z" }}