Invite someone by email

Owner or admin. Only a person signed in to the dashboard (its session key plus X-PostWire-Source: dashboard): an API key or an AI connector gets 403 team_requires_human, even an admin's. The invitation is a signed link that works once, only for that address, for 7 days; the person signs in or up with an emailed code, Google or Apple and joins. The response also carries invite_url, to share yourself. Seats count members plus open invitations: past the plan's seats the answer is 403 seat_limit with the next plan's checkout link. At most 30 invitations a day per workspace. Inviting an address again replaces its open invitation.

post/api/team/invites

Request

  • Base URL: https://postwire.io
  • URL: https://postwire.io/api/team/invites
  • Auth: HTTP bearer

Request body

emailstring email required
role'admin' | 'editor' | 'contributor' | 'approver' | 'viewer' required

admin: everything except billing and ownership. editor: write, schedule, publish within approval rules. contributor: drafts and schedules, every post waits for approval. approver: only the approvals inbox. viewer: read-only.

brand_idsstring[]

Only these brands of the workspace (editor, contributor, approver, viewer). Empty or omitted = every brand.

Response

{ ok, invite: { id, email, role, brand_ids, expires_at }, invite_url, email: { sent, note? }, message }

Changes

No recorded changes to this operation across all 1 revision of this API.