Skip to content

Rename an organization

Change the name of one of your organizations, and nothing else about it.

Updated

patch

https://cloud.cahaves.com/api/organizations/{id}

Authorization

cahaves.cloud.sessionstringcookierequired

The session cookie Cloud sets when a customer signs in to the console with GitHub or Google. It is HttpOnly, so scripts cannot read it, and there are no API keys or tokens yet.

Path parameters

idstring<uuid>required

The organization's id.

Example: "2f6c8e0a-4b1d-4e7f-9a3c-5d7e9f1b3a5c"

Headers

X-Cloud-Organizationstring<uuid>

The id of the organization the request works in, one the signed-in customer owns. Left out or empty, the request works in their oldest organization. Any other value answers 404 with `reason: "organization"`. A customer with no organization yet gets 409 "Create an organization first." from every route that works in one.

Example: "2f6c8e0a-4b1d-4e7f-9a3c-5d7e9f1b3a5c"

Body

application/jsonrequired

namestringrequired

1 to 80 characters once each run of spaces is one space and the ends are trimmed, with no control characters.

Responses

application/json

The renamed organization.

organizationobjectrequired

Changes the name and nothing else: the organization's id, its projects and their slugs, its workspace and its billing stay as they were. The organization renamed is the one in the path, whichever one X-Cloud-Organization names.

The new name follows the rules of Create an organization, apart from the limit of 10, and answers the same 422 sentences, each naming name. Changing only a name's capitals is a rename like any other, and sending the current name changes nothing. An id that is not one of the customer's organizations answers 404 with "That does not exist."