Invites

Invite a member

POST/v1/workspaces/{workspaceId}/invites

Invite someone by email to join as a member. WorkOS emails them a link, and they accept by signing in or signing up with that address. It fails with 409 already_member if they are already in the workspace, and with 403 plan_limit when members plus pending invites fill the plan's users. A member limited to some brands can't invite, because the new member would see every brand, and gets 403 brand_access_limited.

curl -X POST "$AYEFORM_API/v1/workspaces/$WORKSPACE_ID/invites" \
  -H "Authorization: Bearer $AYEFORM_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "email": "orders@luigispizza.com"
  }'

Path parameters

workspaceIdstringrequired
The workspace's id. An API key can only use its own workspace.

Body

JSON, with Content-Type: application/json.

emailstringrequired
The email address to invite. An address that already has a pending invite gets it again, or a fresh one if it expired.
max 320 chars · email

Response

200 with a JSON body.

Errors answer with a status and the error shape.