Teamly API
  1. Category
Teamly API
  • Introduction
  • Getting Started
    • Quick Start
    • API Versions
  • Permissions
    • Channel Permission Values
    • Team Global Permissions
  • Core Resources
    • Channels
      • Update Channel
        • Update Team Channel
        • Update Channel Role Permissions
      • Get Team Channels
      • Create Team Channel
      • Delete Team Channel
      • Duplicate a Channel on Team
      • Update Channel Priorities of Team
    • Messages
      • Create Channel Message
      • Delete a Channel Message
      • Get Channel Messages
      • Update a Channel Message
      • React to Message
      • Delete Reaction from Message
      • Get a Channel Message by Id
    • Teams
      • Members
        • Add Role to Member
        • Remove Role from Member
        • Kick Member from Team
        • Get Member
      • Bans
        • Get Banned Users
        • Unban User
        • Ban User
      • Get a Team
      • Update a Team
    • Roles
      • Create a Role for Team
      • Get Team Roles
      • Delete a Role
      • Clone Role
      • Update Role Priorities of Team
      • Update a Team Role
    • Users
      • Get User By Id
      • Get Logged In User
    • Todos
      • Get Todo Items
      • Create Todo Item
      • Delete Todo Item
      • Clone Todo Item
      • Update Todo Item
    • Direct Messages
      • Create a Direct Message
    • Applications
      • Get Application Submissions
      • Update a Application Status
      • Update Team's Application Status
      • Update Team's Application Questions
      • Get Application By Id
    • Reactions
      • Get Team's Custom Reactions
      • Create New Custom Reaction for Team
      • Update a Custom Reaction
      • Delete a Custom Reaction
    • Attachments
      • Upload Attachment
    • Voice
      • Get Credentials for Join Voice Channel
      • Update Your Voice Metadata
      • Leave from Voice Channel
    • Webhooks
      • Create Message With Webhook
      • Webhook for GitHub
    • Blog
      • Get Blog Posts
      • Create a Blog Post
      • Delete a Blog Post
    • Category
      • Create a Category
        POST
      • Update a Category
        PUT
      • Update Category Role Permissions
        POST
      • Delete a Category
        DELETE
      • Add a Channel To Category
        POST
      • Delete a channel from category
        DELETE
      • Set channel priority of category
        POST
      • Set a team's category priority
        POST
  • Schemas
    • Message
    • Message Embed
    • Channel
    • Direct Message
    • To-do Item
    • Application
    • Emoji
    • Team
    • User
    • Role
    • Webhook
    • Blog
    • Category
  • Websockets
    • Example Bot
    • WebSocket event envelope
      • WebSocket event envelope
      • Keepalive
      • Welcome Message
      • Gateway Opcodes
      • Gateway Close Event Codes
    • Websocket events
      • CHANNEL_CREATED
      • CHANNEL_DELETED
      • CHANNEL_UPDATED
      • MESSAGE_SEND
      • MESSAGE_UPDATED
      • MESSAGE_DELETED
      • MESSAGE_REACTION_ADDED
      • MESSAGE_REACTION_REMOVED
      • PRESENCE_UPDATE
      • TEAM_ROLE_CREATED
      • TEAM_ROLE_DELETED
      • TEAM_ROLES_UPDATED
      • TEAM_UPDATED
      • TODO_ITEM_CREATED
      • TODO_ITEM_DELETED
      • TODO_ITEM_UPDATED
      • USER_JOINED_TEAM
      • USER_LEFT_TEAM
      • USER_JOINED_VOICE_CHANNEL
      • USER_LEFT_VOICE_CHANNEL
      • USER_PROFILE_UPDATED
      • USER_ROLE_ADDED
      • USER_ROLE_REMOVED
      • USER_UPDATED_VOICE_METADATA
      • BLOG_CREATED
      • BLOG_DELETED
      • CATEGORIES_PRIORITY_UPDATED
      • CATEGORY_UPDATED
      • CATEGORY_DELETED
      • CATEGORY_CREATED
      • CHANNELS_PRIORITY_UPDATED
    • Connecting via WebSocket
  1. Category

Update a Category

PUT
https://api.teamly.one/api/v1/teams/{teamId}/categories/{categoryId}

Request

Path Params
teamId
string 
required
categoryId
string 
required
Header Params
Authorization
string 
required
Default:
Bot {token}
Content-Type
string 
required
Default:
application/json
Body Params application/json
name
string 
required
name
Example
{
  "name": "string"
}

Request samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request PUT 'https://api.teamly.one/api/v1/teams//categories/' \
--header 'Authorization;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "string"
}'

Responses

🟢200Success
application/json
Body
success
boolean 
required
category
object (Category) 
required
group
id
string 
required
Unique identifier for the category
teamId
string 
required
ID of the team associated with the category
name
string 
required
Name of the category
createdBy
string 
required
ID of the user who created the category
priority
number 
optional
Priority level of the category
Default:
null
permissions
object 
required
Permissions for the channel, containing roles and their associated permissions
createdAt
string <date-time>
required
Timestamp of when the category was created
Default:
CURRENT_TIMESTAMP
editedAt
string <date-time>
optional
Timestamp of when the category was last edited
Default:
null
Example
{
  "success": true,
  "category": {
    "id": "string",
    "teamId": "string",
    "name": "string",
    "createdBy": "string",
    "priority": null,
    "permissions": {
      "role": {
        "roleId": "string",
        "allow": 0,
        "deny": 0
      }
    },
    "createdAt": "CURRENT_TIMESTAMP",
    "editedAt": null
  }
}
Previous
Create a Category
Next
Update Category Role Permissions
Built with