Clone Role - Teamly API

Request

Path Params

teamId

string

required

roleId

string

required

Header Params

Authorization

string

required

Default:

Bot {token}

Content-Type

string

required

Default:

application/json

Request samples

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

Responses

🟢200Success

application/json

Body

success

boolean

required

role

object (Role)

required

id

string

required

Unique identifier for the role

teamId

string

required

ID of the team associated with the role

name

string

required

Name of the role

iconUrl

string <uri>

optional

URL of the role's icon

Default:

null

color

string

required

Hexadecimal color code for the role

color2

string

optional

Additional color code for the role

Default:

null

permissions

number

required

Permission level of the role

Default:

0

priority

number

required

Priority of the role

Default:

0

createdAt

string <date-time>

required

Timestamp of when the role was created

Default:

CURRENT_TIMESTAMP

updatedAt

string <date-time>

optional

Timestamp of when the role was last updated

Default:

null

isDisplayedSeparately

boolean

required

Indicates if the role is displayed separately

Default:

true

isSelfAssignable

boolean

optional

Indicates if the role is self-assignable

Default:

false

iconEmojiId

string

optional

ID of the emoji used as the role's icon

Default:

null

mentionable

boolean

required

Indicates if the role is mentionable

Default:

true

botScope

object

required

Bot-specific scope information for the role

Default:

{}

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": {}
  }
}