POST/api/v1/workspaces/{workspace_id}/invitations

Invite someone

Emails someone an invitation to join the workspace.

API token required20 per hour per IP

Guide: Members and roles

Code samples and Try it

Path parameters

#
  • workspace_idstringRequired

    The workspace's id, from the address of its settings page (markdrop.in/settings/workspaces/<workspace-id>) or from List workspaces.

Request body

#

application/json, required

  • emailstring (email)Required
  • role"admin" | "member" | "viewer"

    admin, member or viewer. See Members and roles. Default "member".

Responses

#
  • 201Created.
  • 401No token, or the token is revoked or mistyped.
  • 422The request didn't validate. detail lists each problem, with where it is (loc) and why (msg).
  • 429Too many requests from your IP address. Wait the seconds in Retry-After.
201 response: 8 fields (InviteResponse)
  • idstring
  • emailstring
  • role"owner" | "admin" | "member" | "viewer"
  • status"pending" | "accepted" | "declined" | "revoked" | "expired"
  • created_atstring (date-time)

    ISO 8601, for example 2026-11-30T12:00:00Z.

  • expires_atstring (date-time)

    ISO 8601, for example 2026-11-30T12:00:00Z.

  • invited_by_namestring | null
  • responded_atstring (date-time) | null

    ISO 8601, for example 2026-11-30T12:00:00Z.

Did this page help?