Admiral

Organization

Update the current organization

PATCH
/v1/organization

Only display_name is mutable. slug is part of the account's identity and status is set by lifecycle operations, neither of which an organization performs on itself. The logo is set in the console.

Scope: organization:write

Authorization

bearerAuth
AuthorizationBearer <token>

An API key, or an access token minted from one. Pass it in the Authorization header: Bearer admp_...

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

UpdateOrganizationRequest updates the caller's own organization, so it names no id.

Response Body

application/json

curl -X PATCH "https://example.com/v1/organization" \  -H "Content-Type: application/json" \  -d '{    "organization": {}  }'
{  "organization": {    "id": "string",    "slug": "string",    "display_name": "string",    "status": "STATUS_UNSPECIFIED",    "avatar_url": "string",    "created_at": "2023-01-15T01:30:15.01Z",    "updated_at": "2023-01-15T01:30:15.01Z"  }}