Invite someone
Returns a link to send them; there is no email yet. An address that already has an open invitation gets that invitation back — the same link, not a new one — with handedBack: true. To change the role on it, revoke it and invite again.
The owner may invite admins and members; an admin may invite members.
Authorization
apiKey Authorization: Bearer fx_live_<id>_<secret>.
A key is shown once, at creation. We cannot show it again or recover it for you.
Keys carry an environment (live or test) in the key itself, so a test key pasted into a
production config fails immediately instead of at the worst possible moment.
Scopes are per key. A key without accounts:write can read accounts and nothing else.
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/v1/members/invitations" \ -H "Content-Type: application/json" \ -d '{ "email": "[email protected]", "role": "admin" }'{ "data": { "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08", "email": "string", "role": "admin", "url": "string", "invitedBy": null, "expiresAt": "2019-08-24T14:15:22Z", "createdAt": "2019-08-24T14:15:22Z", "handedBack": true }}