API Reference · Account

Rename Organization

Rename an organization

PATCH/v1/organizations/{organization_id}

Account required

cURL example

cURL request

curl -X PATCH "https://api.verifiedinbox.ai/v1/organizations/0192a5e0-1234-7000-8000-000000000002" \
  -H "Authorization: Bearer vi_live_YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "Acme Inc."
  }'

Parameters

Parameter	Type	Description
organization_idpathrequired	string (uuid)	Organization id.
VI-Environmentheader	string	`live` (default) or `test`. Used for anonymous callers and OAuth access tokens; API keys and web sessions carry their own environment.

Request body

application/json · required

Field	Type	Description
namerequired	string	—

Example request payload (OrganizationNameRequest)

{
  "name": "Acme Inc."
}

Response

200 OKRenamed.

application/json

Field	Type	Description
applications_countrequired	integer	—
created_atrequired	string (date-time)	—
idrequired	string (uuid)	—
members_countrequired	integer	—
namerequired	string	—
rolerequired	string	— Allowed: `owner`, `admin`, `member`

Example 200 response (Organization)

{
  "applications_count": 1,
  "created_at": "2026-10-31T12:00:00Z",
  "id": "0192a5e0-1234-7000-8000-000000000001",
  "members_count": 1,
  "name": "Acme Inc.",
  "role": "owner"
}

Other responses & possible errors

Expand a status code below to see the error code, description, and example error payload.

400 (invalid_request)`invalid_request` — the request is malformed.

`invalid_request` — the request is malformed.

Example 400 error response

{
  "error": {
    "code": "invalid_request",
    "message": "Please provide a valid domain name."
  }
}

401 (unauthenticated)`unauthenticated` — sign in / send a valid credential. `next_action.kind = sign_in`.

`unauthenticated` — sign in / send a valid credential. `next_action.kind = sign_in`.

Example 401 error response

{
  "error": {
    "code": "unauthenticated",
    "message": "Sign in or provide an API key to continue.",
    "next_action": {
      "kind": "sign_in",
      "title": "Sign in or create an account",
      "url": "/login"
    }
  }
}

404 (not_found)`not_found` — doesn't exist or isn't accessible to you (never 403).

`not_found` — doesn't exist or isn't accessible to you (never 403).

Example 404 error response

{
  "error": {
    "code": "not_found",
    "message": "We couldn't find that resource."
  }
}

422 (unprocessable)`unprocessable` / `blocked_provider` — understood but can't be done (plain-English reason).

`unprocessable` / `blocked_provider` — understood but can't be done (plain-English reason).

Example 422 error response

{
  "error": {
    "code": "unprocessable",
    "message": "Shared mailbox providers like gmail.com cannot be verified."
  }
}

429 (rate_limited)`rate_limited` — retry after `Retry-After` seconds (`details.retry_after_seconds`). `limit_reached` — a quota is used up; `details.limit` names it and `next_action` offers support.

`rate_limited` — retry after `Retry-After` seconds (`details.retry_after_seconds`). `limit_reached` — a quota is used up; `details.limit` names it and `next_action` offers support.

Example 429 error response

{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Please wait a moment and try again."
  }
}

Was it helpful?