Organization

Add Member

Invites a person to your organization. They receive an email invitation and hold no access until they accept, so the roster is unchanged until then.

Check data.email_sent. The invitation is recorded whether or not the email goes out. When it is false the invitee was never told, and re-inviting is refused with ALREADY_INVITED — revoke it with Remove Member and invite again.

Requires the members:write scope, which only an org admin's API key can carry.

Refusals carry a code:

code	Status	Meaning
ALREADY_MEMBER	409	That email is already on the roster
ALREADY_INVITED	409	That email already has a pending invitation
MEMBER_LIMIT_REACHED	403	Your plan's seat limit is full — pending invitations reserve a seat
NOT_ORG_LEAD	403	The key's creator is no longer an org admin

post/api/v1/org/members

Request

Base URL
http://localhost:3009
Auth
HTTP bearer

Request body

emailstring required

Email address to invite. Matched case-insensitively against the existing roster.

role'admin' | 'member' required

Role the invitation carries. admin can manage members and billing, member can build and run workflows. The narrow third role (user) is not invitable over the API yet.

Example request

{
  "email": "sam@acme.com"
}

Response

Created — the invitation is recorded and the invitee has been emailed

statusinteger

messagestring

Changes

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