Update Project User Group

PUT /public/v1/projects/{projectId}/user-groups/{projectUserGroupId}
Api key

Headers

  • X-COMPANY-ID string Required

    The company's unique ID

Path parameters

  • projectId integer(int64) Required
  • projectUserGroupId string(uuid) Required
application/json

Body Required

  • userGroupId string(uuid)
  • role string
  • disableNotification boolean

Responses

  • 500 */*

    Internal Server Error
  • 200 */*

    OK

    Hide response attributes Show response attributes object
    • id string(uuid)
    • userGroup object Required

      User Group Response

      Hide userGroup attributes Show userGroup attributes object
      • id string(uuid) Required

        The ID of the user group

      • name string Required

        The name of the user group

      • users array[object] Required

        The list of users in the user group

        User Response

        Hide users attributes Show users attributes object
        • id string(uuid) Required

          The ID of the user

        • firstName string Required

          The first name of the user

        • lastName string Required

          The last name of the user

        • email string Required

          The email of the user

        • phoneNumber string Required

          The phone number of the user

        • title string Required

          The title of the user

        • lastLogin string(date-time) Required

          The last login time of the user

        • loginCount integer(int64) Required

          The login count of the user

        • role string Required

          The role of the user

        • ssoUser boolean Required

          Indicates if the user is an SSO user

        • reportingRestricted boolean Required

          Indicates if reporting is restricted for the user

    • role string
    • roleId string(uuid)
PUT /public/v1/projects/{projectId}/user-groups/{projectUserGroupId} 
curl \
 --request PUT 'https://live.smartpmtech.com/public/v1/projects/{projectId}/user-groups/{projectUserGroupId}' \
 --header "X-API-KEY: $API_KEY" \
 --header "Content-Type: application/json" \
 --header "X-COMPANY-ID: string" \
 --data '{"userGroupId":"string","role":"string","disableNotification":true}'
Request examples 
# Headers
X-COMPANY-ID: string

# Payload
{
  "userGroupId": "string",
  "role": "string",
  "disableNotification": true
}
Response examples (500) 
{}
Response examples (200) 
{
  "id": "string",
  "userGroup": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Project Managers",
    "users": [
      {
        "id": "550e8400-e29b-41d4-a716-446655440000",
        "firstName": "Kirby",
        "lastName": "Smart",
        "email": "kirby.smart@blah.com",
        "phoneNumber": "+1-555-123-4567",
        "title": "Project Manager",
        "lastLogin": "2024-01-01T12:00:00+00:00",
        "loginCount": 42,
        "role": "Admin",
        "ssoUser": true,
        "reportingRestricted": false
      }
    ]
  },
  "role": "string",
  "roleId": "string"
}