Skip to content
OpenRelay is in early access, and the /v1 API is stable. New capabilities ship in the changelog.
API ReferenceAccount and accessAccount

Update the caller's profile

Sets the signed-in user's full name, avatar URL or default organization and returns the profile. The default must be an org the user belongs to (403 otherwise). Requires a signed-in dashboard session token; API keys cannot call this endpoint.

Required permission

Requires the self.update permission. See Permissions for the roles and API key permissions that include it.

Command line

The orl CLI wraps this endpoint:

orl account profile update
PATCH
/v1/me/profile

Authorization

apiKey
headerAuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer or_… (legacy vl_… keys still work).

Request Body

application/json
  1. body
fullName?string
avatarUrl?string
defaultOrganizationId?string

Response Body

Updated

application/json
  1. response
id*string
email*string
fullName?string
avatarUrl?string
defaultOrganizationId?string
Example Request
curl -X PATCH 'https://api.openrelay.inc/v1/me/profile' \  -H 'Content-Type: application/json' \  -d '{}'
Example Response
{  "id": "string",  "email": "string",  "fullName": "string",  "avatarUrl": "string",  "defaultOrganizationId": "string"}