SHshapemaker
externals

Invite External

Invite an external collaborator by email. Creates their account and sends an invite email with a password setup link. Site grants are applied afterwards via the sites endpoints.

post/v1/externals

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

Request body

emailstring required
companystring required
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.