COconnecteam
Users:v1:Pending Request Users

Update pending user

Update an existing pending user request.

put/users/v1/pending-users/{pendingUserId}

Request

  • Base URL
    https://api.connecteam.com
  • URL
    https://api.connecteam.com/users/v1/pending-users/{pendingUserId}
  • Auth
    • API key in header X-API-KEY
    • or OAuth 2
      Client credentials
      Token URL: /oauth/v1/token scopes: users.write

Path parameters

pendingUserIdinteger required

The ID of the pending user request to update.

Request body

firstNamestring required

The user's first name

lastNamestring required

The user's last name

phoneNumberstring

The user's phone number

emailstring

The user's email (mandatory for managers and owners)

rawFieldsobject

The user's raw fields

linkIdinteger

The id of the invite link

sourcestring

The source of the user

userIdinteger

Connecteam user id of the user

suggestedUserIdinteger

Connecteam user id of the user for the admin to match

sourceIconstring

The icon of the external system if users come from integration

externalUserIdstring

The user ID from external system

integrationIdinteger

The integration ID from the integration service

extraFieldsobject

Extra fields from integration

profilePictureFileIdstring

The file ID obtained from the upload attachment endpoint (POST /attachments/v1/files/generate-upload-url) with featureType set to 'users'. The file must be finalized via the complete-upload endpoint before use.

Response

Successful Response

requestIdstring
dataUpdatePendingUserResponse required

Changes

No recorded changes to this operation across all 2 revisions of this API.