Create a Role for Team

POST

https://api.teamly.one/api/v1/teams/{teamId}/roles

Request

Path Params

Header Params

Body Params application/json

Example

{
  "required": [],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the role",
      "nullable": true
    },
    "permissions": {
      "type": "number",
      "description": "Permissions level associated with the role",
      "nullable": true
    },
    "color": {
      "type": "string",
      "description": "Color code for the role in hexadecimal format",
      "nullable": true
    },
    "color2": {
      "type": "string",
      "description": "An additional color code for the role (optional)",
      "nullable": true
    },
    "isDisplayedSeparately": {
      "type": "boolean",
      "description": "Indicates whether the role should be displayed separately",
      "nullable": true
    }
  },
  "x-apidog-orders": [
    "name",
    "permissions",
    "color",
    "color2",
    "isDisplayedSeparately"
  ]
}

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request POST 'https://api.teamly.one/api/v1/teams//roles' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
  "required": [],
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "The name of the role",
      "nullable": true
    },
    "permissions": {
      "type": "number",
      "description": "Permissions level associated with the role",
      "nullable": true
    },
    "color": {
      "type": "string",
      "description": "Color code for the role in hexadecimal format",
      "nullable": true
    },
    "color2": {
      "type": "string",
      "description": "An additional color code for the role (optional)",
      "nullable": true
    },
    "isDisplayedSeparately": {
      "type": "boolean",
      "description": "Indicates whether the role should be displayed separately",
      "nullable": true
    }
  },
  "x-apidog-orders": [
    "name",
    "permissions",
    "color",
    "color2",
    "isDisplayedSeparately"
  ]
}'

Responses

🟢200Success

application/json

Body

Example

{
    "success": true,
    "role": {
        "id": "string",
        "teamId": "string",
        "name": "string",
        "iconUrl": null,
        "color": "string",
        "color2": null,
        "permissions": 0,
        "priority": 0,
        "createdAt": "CURRENT_TIMESTAMP",
        "updatedAt": null,
        "isDisplayedSeparately": true,
        "isSelfAssignable": false,
        "iconEmojiId": null,
        "mentionable": true,
        "botScope": {}
    }
}

Modified at 2024-12-28 15:58:52

Update a Team

Get Team Roles