PUT
/
v1
/
organizations
/
{id}
Update Organization
curl --request PUT \
  --url https://api.vertracloud.app/v1/organizations/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "updates": {}
}'
{
  "status": "success",
  "response": {
    "id": "org123",
    "name": "updatedorganization",
    "description": "Updated description",
    "tags": ["newtag", "updated"],
    "owner_id": "993591427428790342",
    "created_at": "2025-08-14T19:58:00Z",
    "updated_at": "2025-08-14T20:00:00Z",
    "members": [
      {
        "user_id": "993591427428790342",
        "role": "owner",
        "joined_at": "2025-08-14T19:58:00Z"
      }
    ]
  }
}
id
string
required
The ID of the organization to update.
updates
object
The fields to update for the organization.

Response

status
string
Indicates whether the call was successful. success if successful, error if not.
response
object
The updated details of the organization.
{
  "status": "success",
  "response": {
    "id": "org123",
    "name": "updatedorganization",
    "description": "Updated description",
    "tags": ["newtag", "updated"],
    "owner_id": "993591427428790342",
    "created_at": "2025-08-14T19:58:00Z",
    "updated_at": "2025-08-14T20:00:00Z",
    "members": [
      {
        "user_id": "993591427428790342",
        "role": "owner",
        "joined_at": "2025-08-14T19:58:00Z"
      }
    ]
  }
}

Error Responses

status
string
Indicates whether the call was successful. error if not successful.
code
string
The error code indicating the reason for failure. Possible values:
  • UNAUTHORIZED: The user is not authenticated.
  • NAME_MUST_BE_A_STRING: The provided name is not a string.
  • DESCRIPTION_MUST_BE_A_STRING: The provided description is not a string.
  • TAGS_MUST_BE_AN_ARRAY: The provided tags are not an array of strings.
  • NAME_TOO_LONG: The provided name exceeds 50 characters.
  • DESCRIPTION_TOO_LONG: The provided description exceeds 200 characters.
  • TAG_TOO_LONG: One or more tags exceed 20 characters.
  • ORGANIZATION_NAME_ALREADY_EXISTS: An organization with the provided name already exists.
{
  "status": "error",
  "code": "UNAUTHORIZED"
}