Rename the organization

PATCH

/api/v1/organizations/{id}

curl --request PATCH \
  --url http://localhost:3000/api/v1/organizations/example \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example" }'

Admin on the organization.

Any caller; the scope needed is checked on what it acts on.

Authorizations

• bearer
• session
• None

Parameters

Path Parameters

id

required

string

Organization id

Request Body^required

Media typeapplication/json

object

name

required

string

>= 1 characters <= 80 characters

Example^generated

{
  "name": "example"
}

Responses

200

Renamed

Media typeapplication/json

object

data

required

object

id

required

string format: uuid

/^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

slug

required

string

name

required

string

Example^generated

{
  "data": {
    "id": "2489E9AD-2EE2-8E00-8EC9-32D5F69181C0",
    "slug": "example",
    "name": "example"
  }
}

default

An error

Media typeapplication/json

object

error

required

object

code

required

string

message

required

string

detail

Example^generated

{
  "error": {
    "code": "example",
    "message": "example",
    "detail": "example"
  }
}