Promote to Admin
The Promote to Admin endpoint allows you to elevate an existing user to manager (admin) status, granting them additional permissions in Connecteam.
Endpoint
POST /users/v1/admins
Request Body
| Field | Type | Required | Description |
|---|---|---|---|
| userId | integer | Yes | The ID of the user to promote |
| string | Yes | Email address for the admin invitation | |
| title | string | No | Job title for the admin |
Request Example
{
"userId": 7031021,
"email": "[email protected]",
"title": "Team Manager"
}Success Response (200)
{
"requestId": "xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx",
"data": {
"success": true,
"userId": 7031021
}
}What Happens When a User is Promoted
- User's email is updated to the specified address
- User receives manager/admin permissions
- An invitation email is sent to the specified email address
- User type changes from
usertoadmin
Error Responses
| Status | Error | Description |
|---|---|---|
| 400 | User not found | The specified userId does not exist |
| 400 | User already manager | The user already has admin permissions |
| 400 | Duplicate email | This email is already in use by another admin |
| 403 | Email is blacklisted | The email address is on the blacklist |
NoteTo demote an admin back to a regular user, use the Update Users endpoint with the appropriate userType.
Updated 11 days ago