Remotehost Docs
API ReferenceOrganizations

Rename an organization or change its slug

PATCH
/orgs/{orgId}

Changes the name, the slug, or both; needs org.update (owners and admins). A changed slug leaves the old one as an alias: it keeps reaching the org's members, and no other org can take it until the org releases it. Moving back to one of the org's own old slugs is allowed. Slug changes are rate limited per user.

Authorization

bearerAuth
AuthorizationBearer <token>

A RemoteHost API key (rh_sk_...) or a user session token.

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

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/orgs/string" \  -H "Content-Type: application/json" \  -d '{}'
{  "org": {    "id": "string",    "name": "string",    "slug": "acme",    "plan": "none",    "onboarded_at": "string",    "created_at": "string",    "updated_at": "string"  }}

Create an organization POST

Creates an organization with the caller as its owner. Without a slug, one is derived from the name (`Acme` becomes `acme`, then `acme-2`). Sending the name of an org the caller already belongs to returns that org instead. Rate limited per user. API keys cannot create organizations.

Find one of your organizations by slug GET

Resolves a slug, current or old, among the organizations the caller belongs to. Anything else, including an organization that exists but the caller is not in, is the same 404, so the answer never says whether an organization exists. An API key resolves its own organization only. Address the organization by `org.id` from here on.