Skip to navigation
Workforce APIInvites

Create

Requires the manage_users permission.

Authentication

AuthorizationBearer

An organization API key (mfw_org_key_...), sent as Authorization: Bearer <key>. Create one under Settings → API keys.

Request

This endpoint expects an object.
emailstringRequiredformat: "^[^@\s]+@[^@\s]+\.[^@\s]+$"<=320 characters
namestring or nullOptional<=200 characters
roleenumOptional
Allowed values:

Response

Successful Response
idstringformat: "uuid"
person_idstringformat: "uuid"
emailstring
namestring
roleenum
Allowed values:
invited_by_person_idstring or nullformat: "uuid"
invited_by_namestring or null
expires_atdatetime
created_atdatetime

Errors

422
Unprocessable Entity Error