Team
Invite Team Member
Invite a human to the workspace team by email — sends the same invitation as the in-app flow.
POST
Invites a human to the employer team by email, giving them shared access to the account’s jobs and team inbox once they accept. This sends the same invitation email as the in-app flow.
The outcome depends on the email:
Requirements:
team:write scope + the public_api_team feature + a claimed account (unclaimed accounts get 403 with details.reason: "account_claim_required" and a claimUrl).
Request
string
required
Email address to invite. Must be a valid email.
Response
boolean
true on success.string
invite_created, member_added, or already_member (see the table above).string
The email that was invited.
object
The refreshed team record — same shape as
GET /team — so you can confirm the new member or pending invite without a second call.