externals

Update External

Update an external collaborator: disable or re-enable their account, or set/clear the access expiry date. Disabling keeps the site grants, so a paused engagement can resume without reassignment.

patch/v1/externals/{user_id}

Request

  • Base URL
    https://api.shapemaker.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /v1/auth

Path parameters

user_idinteger required

Request body

disabledboolean nullable
expiresAtUtcstring date-time nullable

Response

Successful Response

idinteger required
uuidstring uuid4 required
emailstring required
displayNamestring nullable
isExternalboolean required
companystring nullable
status'invited' | 'active' | 'disabled' | 'expired' required
expiresAtUtcstring date-time nullable
lastActiveAtUtcstring date-time nullable
grantedSiteCountinteger nullable
invitedByEmailstring nullable
invitedAtUtcstring date-time nullable

Changes

No recorded changes to this operation across all 1 revision of this API.