Invite User To Workspace

Nothing Found

Help Center
API Feature Requests

Nothing Found

Invite User To Workspace

Invite someone to join your Workspace as a member. To invite someone as a guest, use the Invite Guest endpoint.

Note: This endpoint is only available to Workspaces on our Enterprise Plan.

SecurityAuthorization Token

Request

path Parameters

team_id

required

number <double>

Team ID (Workspace)

Request Body schema: application/json

email required	string
admin required	boolean
custom_role_id	integer <int32>

Responses

200

post/team/{team_id}/user

Request samples

application/json

{"email": "user@example.com",
"admin": true
}

Response samples

application/json

{"team": {"id": "333",
"name": "Team Name",
"color": "#8D00D4",
"avatar": null,
"members": [{"user": {"id": 184,
"username": null,
"email": "user@example.com",
"color": null,
"profilePicture": null,
"initials": "G",
"role": 2,
"custom_role": {"id": 112233,
"name": "admin custom"
},
"last_active": null,
"date_joined": null,
"date_invited": "1583358383412"
},
"invited_by": {"id": 183,
"color": "#827718",
"username": "Jerry",
"email": "jerry@example.com",
"initials": "J",
"profilePicture": "https://dev-attachments-public.clickup.com/profilePictures/profile.jpg"
}
}
],
"roles": [{"id": 1,
"name": "owner",
"custom": false
},
{"id": 2,
"name": "admin",
"custom": false
},
{"id": 3,
"name": "member",
"custom": false
},
{"id": 4,
"name": "guest",
"custom": false
},
{"id": 998877,
"name": "member custom",
"inherited_role": 3,
"custom": true
},
{"id": 112233,
"name": "admin custom",
"inherited_role": 2,
"custom": true
},
{"id": 12345,
"name": "guest custom",
"inherited_role": 4,
"custom": true
}
]
}
}

© 2022 ClickUp
Security
Your Privacy
Terms