Invite team member

POST https://datafa.st/api/v1/admin/websites/{websiteId}/team

Invite someone to the website by email. They receive an invitation link to accept and join with the specified role.

Owner only. Website API keys cannot invite team members.

Related: Team member roles

Request

Path parameters

websiteId

string

Website ObjectId. From List websites (_id field). Example: 665f0b3c4d2e1a0012345678.

Body parameters

email

string

required

Email to invite. Example: "colleague@example.com". Lowercased before storage.

role

viewer or member

"viewer" (read-only, default) or "member" (can manage settings). Cannot invite as owner.

Example request body

{
  "email": "colleague@example.com",
  "role": "viewer"
}

Response

Returns a JSON object with status: "success" and endpoint-specific fields in data.

Response fields

data[].message

string

Human-readable confirmation or status message for the operation.

data[].invitationId

string

Invitation ObjectId.

data[].email

string

Invited email address.

data[].role

string

Role assigned by the invite.

Authentication

Use a dft_ account token with team:write + owner role.

A df_ website API key for the same website can also call this route when the path websiteId matches the key's website. Write access with a df_ key is capped at member level — owner-only actions such as team management require a dft_ token and owner role.

Owner only: Inviting and removing team members requires website owner role, even with a dft_ token that has team:write.

Errors

400 — Invalid email, self-invite, or billing seat limit reached.

403 — Caller is not the website owner.

404 — Invited user account not found.

409 — Email is already a member or has a pending invite.

See API errors for the standard error envelope, auth failures, validation errors, permission errors, and rate limits.

✍️ Something missing? Suggest features.

🤖 AI agent or LLM? Read this page as markdown

curl -X POST "https://datafa.st/api/v1/admin/websites/{websiteId}/team" \ -H "Authorization: Bearer dft_xxx" \ -H "Content-Type: application/json" \ -d '{"email":"member@example.com","role":"viewer"}'

{ "status": "success", "data": [{ "message": "Invitation created. Send the invite link to the user.", "invitationId": "665f0b3c4d2e1a0012345678", "email": "member@example.com", "role": "viewer" }] }