Sign in
Users

Modifies a user

Modifies a user identified by userId. userId refers to the user's ID by default, or optionally email as specified by the IdProperty query param.

put/settings/users/2026-03/{userId}

Path parameters

userIdstring required

Query parameters

idProperty'EMAIL' | 'USER_ID'

Request body

firstNamestring

The first name of the user.

lastNamestring

The last name of the user.

primaryTeamIdstring

The user's primary team.

roleIdstring

The user's role.

secondaryTeamIdsstring[]

The user's additional teams.

Response

successful operation

emailstring required

The user's email.

firstNamestring

The user's first name.

idstring required

The user's unique ID.

lastNamestring

The user's last name.

primaryTeamIdstring

The user's primary team

roleIdstring

The user's role.

roleIdsstring[] required

A list of role IDs assigned to the user.

secondaryTeamIdsstring[]

The user's additional teams.

sendWelcomeEmailboolean

Whether a welcome email was sent to the user. This value will only be populated in response to a provisioning request. Subsequent queries will be false.

superAdminboolean required

Whether the user has super admin privileges.

Changes

Changed in 5 of the 14 revisions of this API.10

  • b0d8bc008db93See the full diff
    • ○

      api operation id put-/settings/users/2026-03/{userId}_update removed and replaced with put-/settings/users/2026-03/{userId}

      api-operation-id-removed

    • ○

      the security scope settings.users.write was added to the endpoint's security scheme private_apps

      api-security-scope-added

    • ○

      the security scope crm.objects.users.write was removed from the endpoint's security scheme private_apps

      api-security-scope-removed

    This revision also has 77 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • 3578967e48df2See the full diff
    • ○

      the security scope settings.users.write was added to the endpoint's security scheme private_apps

      api-security-scope-added

    • ○

      the security scope crm.objects.users.write was removed from the endpoint's security scheme private_apps

      api-security-scope-removed

    This revision also has 2 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • e0403341222c2See the full diff
    • ○

      the security scope settings.users.write was added to the endpoint's security scheme private_apps

      api-security-scope-added

    • ○

      the security scope crm.objects.users.write was removed from the endpoint's security scheme private_apps

      api-security-scope-removed

    This revision also has 3 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • f33be5a826102See the full diff
    • ○

      the security scope settings.users.write was added to the endpoint's security scheme private_apps

      api-security-scope-added

    • ○

      the security scope crm.objects.users.write was removed from the endpoint's security scheme private_apps

      api-security-scope-removed

  • dc2fdad57f7f1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 129 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Of the 14 revisions, 1 has no diff computed and 2 have a changelog that could not be searched.