Team Roles

Create a team member role

Changed on

Create a new team member role definition that can then be assigned to members of a team (e.g. "Security Champion", "Tech Lead"). Requires the Edit Settings permission.

post/api/v1/team-roles

Request

  • Base URL
    https://api.getcortexapp.com
  • URL
    https://api.getcortexapp.com/api/v1/team-roles
  • Auth
    HTTP bearer

Request body

descriptionstring

Optional description of the team member role

namestring required

Display name of the team member role

notificationsEnabledboolean

Whether notifications are enabled by default for members assigned this role. Defaults to true.

tagstring required

Unique tag identifying the team member role. May only contain letters, digits, and hyphens.

Example request

{
  "name": "Security Champion",
  "tag": "security-champion"
}

Response

Successfully created the team member role

descriptionstring

Optional description of the team member role

namestring required

Display name of the team member role

notificationsEnabledboolean required

Whether notifications are enabled by default for members assigned this role

tagstring required

Unique tag identifying the team member role

Changes