Skip to main content

Change slug

PUT/api/organization/slug
Administrator

The {slug} is your Organization's address: one DNS label, made from its name when you register. The Public changelog card on the Projects page shows it and lets an administrator change it — which moves the changelog, so links already shared stop working. GET/PUT /api/organization/slug does the same thing, and answers 400 organization_slug_invalid or 409 organization_slug_taken.

Read more: Public changelogSource: OrganizationSlugApiController#change(opens in new tab)

Request body​

application/json

FieldTypeRequiredNotes
slugstringRequiredmax OrganizationSlug.MAX_LENGTH

Response​

Success: 200

FieldTypeRequiredNotes
slugstringOptional

Errors​

StatusCodeApplies to
400validation_faileda field is missing or out of rangeAny endpoint
400malformed_requestthe body cannot be readAny endpoint
400invalid_parametera path or query parameter is missing or does not convert, such as an ID that is not a UUIDAny endpoint
401authentication_requiredno sessionAny endpoint
403access_deniedan administrator endpoint, or a missing or stale CSRF tokenAny endpoint
404not_foundno such addressAny endpoint
405method_not_allowedthe address does not take that methodAny endpoint
415unsupported_media_typethe address does not read a body of that typeAny endpoint
500internal_errora fault ReleaseFlow did not foresee; the body never carries the exception behind itAny endpoint
400output_language_invalidAccount area
400ui_locale_invalidAccount area
400invitation_invalidAccount area
400organization_slug_invalidAccount area
404invitation_not_foundAccount area
404member_not_foundAccount area
409email_already_registeredAccount area
409invitation_already_pendingAccount area
409invitation_email_unavailableAccount area
409organization_slug_takenAccount area
409member_last_administratorAccount area

Request

bash
# Sign in first and keep the session cookie in cookies.txt (see Sessions and CSRF).
# CSRF_HEADER and CSRF_TOKEN are the headerName and token GET /api/csrf returned.
curl -X PUT "http://localhost:8080/api/organization/slug" \
-b cookies.txt -c cookies.txt \
-H "$CSRF_HEADER: $CSRF_TOKEN" \
-H "Content-Type: application/json" \
--data '{
"slug": "<string>"
}'

The request body is an example built from the schema; replace every placeholder.

Response

200

Example

{
  "slug": "<string>"
}