API overview
Update the account name
Choose an operation to see its request, response shape, access rules and implementation source.
WriteAuthenticated
PATCH/api/v1/me
Update the account name
Sanctum session or bearer token. Required bearer ability: account.update
Request
| Field | In | Rule |
|---|---|---|
name | JSON body | Required string; max 255. No email, password or role changes. |
curl --request PATCH "https://shop.example.test/api/v1/me" \
--header 'Accept: application/json' \
--header "Authorization: Bearer $API_TOKEN" \
--header 'Content-Type: application/json' \
--data '{"name":"Alex Example"}'Response200
Success: 200
Response shape (notation, not a captured response)
{ data: { id: integer, name: string, email: string, email_verified: boolean } }Common errors
| HTTP status | Meaning |
|---|---|
401 | unauthenticated: missing or invalid authentication. |
403 | unauthorized, insufficient_scope or ip_not_allowed: check account context, required ability and token IP policy. |
422 | validation_error: invalid input or unmet domain requirements. Payment initiation can also return payment_failed. |
429 | rate_limited: back off before retrying, especially writes. |