Skip to content
EdgeKit

Rename an organization

POST
/v1/org/update
curl --request POST \
  --url https://your-tenant-host/v1/org/update \
  --header 'Content-Type: application/json' \
  --header 'x-edgekit-site-id: site_example' \
  --cookie ek.session_token=<ek.session_token> \
  --data '{ "organizationId": "01926f3a-8b4e-7b33-a944-5e6f7a8b9c0d", "name": "Aperture Science", "logo": null }'

Name and logo only; logo: null clears it. The slug cannot change here, because URLs are built on it. Safe to retry.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
x-edgekit-site-id
required

The site this request is for, within this tenant. Every official EdgeKit SDK sets it from the client you configured; set it yourself only when calling this API directly.

string
>= 1 characters <= 128 characters

Example 

site_example

The site this request is for, within this tenant. Every official EdgeKit SDK sets it from the client you configured; set it yourself only when calling this API directly.

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
organizationId
string format: uuid
>= 1 characters <= 128 characters

Example 

01926f3a-8b4e-7b33-a944-5e6f7a8b9c0d
name
required
string
>= 1 characters <= 200 characters

Example 

Aperture Science
logo
string | null
<= 2048 characters

Example 

null

Responses

Section titled “Responses”

200

Section titled “200”

The updated organization.

Media typeapplication/json
object
id
required
string format: uuid
name
required
string
slug
required
string
logo
required
string | null

Example 

{
  "id": "01926f3a-8b4e-7b33-a944-5e6f7a8b9c0d",
  "name": "Aperture Science",
  "slug": "aperture-science",
  "logo": null
}

400

Section titled “400”

Invalid request.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Example 

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

401

Section titled “401”

Missing or invalid credential.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Example 

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

403

Section titled “403”

Not allowed.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Example 

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

404

Section titled “404”

Resource not found.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Example 

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

422

Section titled “422”

Request validation failed.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Example 

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}

500

Section titled “500”

Unexpected error.

Media typeapplication/json
object
error
required
object
code
required
string
message
required
string
details

Example 

{
  "error": {
    "code": "unauthorized",
    "message": "Invalid or missing API key."
  }
}