ApiMembers

Invite somebody into the business

Invite the holder of an email address. An existing InversePay account is linked rather than duplicated, so somebody who is already a customer keeps one identity and one login.

POST
/api/b/v1/members/invitations

Invite the holder of an email address.

An existing InversePay account is linked rather than duplicated, so somebody who is already a customer keeps one identity and one login.

Authorization

OAuth2PasswordBearer
AuthorizationBearer <token>

In: header

admin_access_token?string|null

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Invite by address, not by user id.

An Admin knows who they mean by their email; they do not know the person's internal id, and requiring one would mean exposing a user lookup to every business in the platform.

Response Body

application/json

application/json

curl -X POST "https://example.com/api/b/v1/members/invitations" \  -H "Content-Type: application/json" \  -d '{    "email": "user@example.com",    "role": "owner"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "user_id": "a169451c-8525-4352-b8ca-070dd449a1a5",  "role": "owner",  "status": "invited",  "invited_by": "0fdabe0c-eb7c-440a-96d2-2c65906c3777"}