Organization API › Organization
Rename the organization
Changes the organization's name or slug. id must be the key's own
organization. A field left out keeps its value; sent empty it is refused
(VALIDATION_FAILED). A slug another organization uses is 409
SLUG_TAKEN.
Permission (API-key scope): identity:org:write.
Authorization
bearerAuth(identity:org:write)apiKeyHeader(identity:org:write)
Parameters
Path parameters
idstring requiredThe id of the member (usr_…), team (team_…), role (role_…), invitation (inv_…) or organization (org_…) the path names.
Request body required
namestringslugstring
Responses
200
The organization.
dataOrganization requiredShow Organization properties
idstringnamestringslugstringplanstringcreated_atstring (date-time)updated_atstring (date-time)
successboolean required
400
The body is not JSON (INVALID_BODY), or name or slug is sent empty (VALIDATION_FAILED, with details).
errorobject requiredcodestring requiredmessagestring requiredrequest_idstringThe response'sX-Request-ID; quote it to support.detailsarray of object requiredfieldstringmessagestring
401
No API key was sent, or it is unknown, revoked or expired (UNAUTHORIZED).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
403
The key lacks the scope, or id is another organization (FORBIDDEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
404
No such organization in the organization (NOT_FOUND).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
409
Another organization uses that slug (SLUG_TAKEN).
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
429
Too many requests (RATE_LIMITED). Wait Retry-After seconds.
Retry-AfterintegerSeconds to wait.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
500
Something went wrong on EvoHub's side (INTERNAL_ERROR). Retry later.
errorobject requiredcodestring requiredMachine-readable code. Branch on this.messagestring requiredHuman-readable explanation.request_idstringThe response'sX-Request-ID; quote it to support.
Example request
curl -X PATCH 'https://evohub.io/api/v1/organizations/string' \
-H 'Content-Type: application/json' \
-H 'Authorization: Bearer <TOKEN>' \
-d '{
"name": "Acme Inc."
}'