PUT api/v4/workspaces
Update workspace. Last Update: 02/08/23

Request headers ↑

Only registered user can perform this action
  Authentication - string - required
    Example of Authentication header : "Bearer TOKEN_FETCHED_FROM_SERVER_DURING_REGISTRATION"

Request body example ↑

For update name
{
  "workspace": {
    "name": "name"
  }
}
For update organization_type
{
  "workspace": {
    "organization_type": "ORGANIZATION_TYPE",
    "custom_organization_type": "CUSTOM_ORGANIZATION_TYPE"
  }
}

Success response body ↑

{
  "id": 1,
  "name": "name",
  "available_users_count": 30,
  "can_add_new_users": true,
  "can_invite_users_count": 29
}

Params

Param name Description
workspace
required

Validations:

  • Must be a Hash
workspace[name]
optional

Validations:

  • Must be a String
workspace[organization_type]
optional

Validations:

  • Must be one of: Public High School, Private High School, College/University, Club/Youth Sports, Other/Not Listed, School District, K12 School, Higher Education, Youth/Club Sports, Other.
workspace[custom_organization_type]
optional

Validations:

  • Must be a String