Update an organization by ID for a User

PUT 
/v1/organizations/:id

Update an organization by ID for a User

Request

Path Parameters

id stringrequired

application/json

Body

required

name stringrequired

Possible values: <= 50 characters

The name of the organization

Responses

200

application/json

Schema

Schema

id stringrequired

The unique ID of the organization

name stringrequired

The name of the organization

plan object

name stringrequired

Possible values: [pro_monthly, pro_yearly, team_monthly, team_yearly]

The name of the organization's plan

status stringrequired

Possible values: [PENDING, ACTIVE, INCOMPLETE, CANCELED]

The status of the organization's plan

Example (from schema)

{
  "id": "abc123",
  "name": "My Organization",
  "plan": {
    "name": "pro_monthly",
    "status": "PENDING"
  }
}

404

Organization not found or not accessible

Loading...