Rename a cohort

PUT

/cohorts/{id}

curl --request PUT \
  --url https://api.retorio.com/be/v2/cohorts/b2d7e4a1_55c3_4f28_9e10_7a3d6c4b8f02 \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "Sales onboarding 2027" }'

Changes the cohort’s name and nothing else: its type, participants and assigned programs stay as they are.

Authentication

Auth

Access key

Roles

Owner / Admin / Custom

Parameters

Path Parameters

id

required

string

Example

b2d7e4a1_55c3_4f28_9e10_7a3d6c4b8f02

Request Body^required

Media typeapplication/json

object

name

required

The new name of the cohort.

string

>= 3 characters

Example

Sales onboarding 2027

Responses

200

OK

Media typeapplication/json

object

extId

required

string

<= 64 characters

name

required

string

<= 255 characters

createdAt

required

string format: date-time

Example ^generated

{
  "extId": "example",
  "name": "example",
  "createdAt": "2026-04-15T12:00:00Z"
}

400

The request body is not valid. Also answered when the request body is not valid JSON.

Media typeapplication/json

Any of:

object

object

message

required

string

status

required

Canonical error name, e.g. INVALID_ARGUMENT.

string

details

nullable

object

object

statusCode

required

integer

message

required

string

error

required

The HTTP reason phrase, e.g. Bad Request.

string

Example ^generated

{
  "message": "example",
  "status": "example",
  "details": "example"
}

401

Not authenticated: the bearer token is missing, malformed, expired or revoked, its sign-in method does not match your organization’s configuration, the user it belongs to was removed, or your organization is deactivated.

Media typeapplication/json

object

message

required

string

status

required

Canonical error name, e.g. INVALID_ARGUMENT.

string

details

nullable

Example ^generated

{
  "message": "example",
  "status": "example",
  "details": "example"
}

403

Refused: the token does not belong to an admin, or your organization does not have the coaching product, or the admin’s roles do not grant cohorts:manage.

Media typeapplication/json

Any of:

object

object

message

required

string

status

required

Canonical error name, e.g. INVALID_ARGUMENT.

string

details

nullable

object

object

error

required

string

object

object

statusCode

required

integer

message

required

string

error

required

The HTTP reason phrase, e.g. Bad Request.

string

Example ^generated

{
  "message": "example",
  "status": "example",
  "details": "example"
}

404

No cohort with this id in your organization.

Media typeapplication/json

object

message

required

string

status

required

Canonical error name, e.g. INVALID_ARGUMENT.

string

details

nullable

Example ^generated

{
  "message": "example",
  "status": "example",
  "details": "example"
}

413

The request body is larger than 10 MB.

Media typeapplication/json

object

statusCode

required

integer

message

required

string

error

required

The HTTP reason phrase, e.g. Bad Request.

string

Example ^generated

{
  "statusCode": 1,
  "message": "example",
  "error": "example"
}

415

The Content-Type charset or the Content-Encoding is one the API cannot decode. Send UTF-8 JSON without a content encoding.

Media typeapplication/json

object

statusCode

required

integer

message

required

string

error

required

The HTTP reason phrase, e.g. Bad Request.

string

Example ^generated

{
  "statusCode": 1,
  "message": "example",
  "error": "example"
}

500

Internal Server Error

Media typeapplication/json

object

key

additional properties

nullable

Example ^generated

{
  "additionalProperty": "example"
}