Tolgee Octri Demo
POST/v2/slug/generate-organization

Generate an organization slug

Generates an organization slug from a supplied name. Provide a non-empty name; you can also pass oldSlug when generating a replacement slug.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

2 body fields

Organization name and optional existing slug to use when generating a slug.

namestringrequired
The organization name used to generate the slug. Must contain at least one character.
oldSlugstringoptional
An existing organization slug to provide when generating a replacement.

5 status codes
200Returns the generated organization slug as a string.
400Returned when the request is invalid, including when `name` is missing or empty.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
401Returned when authentication is missing or invalid.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
403Returned when the authenticated user does not have access to this operation.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional
404Returned when the requested resource is not found.
codestringrequired
Allowed:unauthenticatedapi_access_forbiddenapi_key_not_foundinvalid_api_keyinvalid_project_api_keyproject_api_key_expiredbad_credentialsmfa_enabledinvalid_otp_codemfa_not_enabledcan_not_revoke_own_permissionsdata_corrupted
paramsarray<object>optional

Error handling

name is required and must contain at least one character. A 400 indicates invalid input, a 401 indicates missing or invalid authentication, a 403 indicates insufficient access, and a 404 indicates that the requested resource was not found.