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

Update an organization (owner/admin)

PATCH
/v1/orgs/{orgId}

Authorization

apiKey
AuthorizationBearer <token>

OpenRelay API key. Send it as Authorization: Bearer vl_….

In: header

Path Parameters

orgId*string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/v1/orgs/string" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": "string",
  "shortId": "string",
  "name": "string",
  "slug": "string",
  "billingEmail": "string",
  "plan": "string",
  "isProvider": true,
  "createdAt": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}
{
  "error": "string",
  "code": "string"
}

Command line

The orl CLI wraps this endpoint:

orl organizations update

Get an organization GET

Previous Page

Invite a member by email (owner/admin) POST

Records a pending invite and emails the address. The response status is always "invited"; the user becomes a member only after they accept (POST /v1/me/invites/{orgId}/accept). Re-inviting the same email refreshes the invite's role and expiry. 409 if the email already belongs to a member.