Generated by API Evangelist
Written by API Evangelist tooling for Clickup's API. It is a proposal applied on top of the contract, not a document Clickup publishes.
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
title: API Evangelist conversational phrasing for Clickup User Groups API
version: 1.0.0
extends: openapi/clickup-user-groups-api-openapi.yml
actions:
- target: $.info
update:
x-apievangelist-phrasing:
method: generated
generated: '2026-09-26'
generator: build-phrasing.py
label: Generated by API Evangelist
operations: 4
- target: $.paths['/v2/team/{team_id}/group'].post
update:
x-apievangelist-phrasing:
intent: Create a user group
effect: write
questions:
- How do I create a ClickUp user group so I can @mention a whole team at once?
- Can I give a new user group a handle and its initial members?
instructions:
- text: Create user group {name} in Workspace {team_id} with members {members}.
slots:
name: requestBody.name
team_id: path.team_id
members: requestBody.members
- text: Set up group {name} with handle {handle} and members {members} in {team_id}.
slots:
name: requestBody.name
handle: requestBody.handle
members: requestBody.members
team_id: path.team_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/group/{group_id}'].put
update:
x-apievangelist-phrasing:
intent: Rename a user group or change members
effect: write
questions:
- Can I add or remove people from an existing user group?
- Is it possible to change a user group's handle?
instructions:
- text: Update the members of user group {group_id} with {members}.
slots:
group_id: path.group_id
members: requestBody.members
- text: Rename user group {group_id} to {name} with handle {handle}.
slots:
group_id: path.group_id
name: requestBody.name
handle: requestBody.handle
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/group/{group_id}'].delete
update:
x-apievangelist-phrasing:
intent: Delete a user group
effect: destructive
questions:
- What's involved in removing a user group from my Workspace?
- Does deleting a user group remove its members from the Workspace?
instructions:
- text: Delete user group {group_id}.
slots:
group_id: path.group_id
- text: Remove group {group_id} from the Workspace.
slots:
group_id: path.group_id
method: generated
generated: '2026-09-26'
- target: $.paths['/v2/group'].get
update:
x-apievangelist-phrasing:
intent: List user groups in a Workspace
effect: read
questions:
- Which user groups exist in my Workspace and who is in them?
- Can I fetch only certain user groups by ID?
instructions:
- text: List the user groups in Workspace {team_id}.
slots:
team_id: query.team_id
- text: Show user groups {group_ids} from Workspace {team_id}.
slots:
group_ids: query.group_ids
team_id: query.team_id
method: generated
generated: '2026-09-26'
Discovery needs no key. Ratings and market analysis are Pro.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.