Skip to main content
POST
/
accounts
/
self
/
member-invitations
const axios = require('axios');
const AccountsApiFp = require('@alohi/faxplus-api').AccountsApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    // Header required only when using the OAuth2 token scheme
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function inviteMembers() {
    const emails = ["[email protected]", "[email protected]"];
    const req = await AccountsApiFp(config).inviteMembers(emails);
    const resp = await req(axios);
}

inviteMembers()

{
  "message": "Invitations sent successfully"
}
You can invite up to 10 users per request. If you need to invite more users, make multiple requests.
const axios = require('axios');
const AccountsApiFp = require('@alohi/faxplus-api').AccountsApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    // Header required only when using the OAuth2 token scheme
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function inviteMembers() {
    const emails = ["[email protected]", "[email protected]"];
    const req = await AccountsApiFp(config).inviteMembers(emails);
    const resp = await req(axios);
}

inviteMembers()

Authorizations

​
Authorization
string
header
required

OAuth2 Authorization Grant

Body

application/json

List of email addresses to invite

Required array length: 1 - 10 elements

Email address of the user to invite or resend invitation to

Response

Invitations sent successfully

​
message
string
Example:

"Invitations sent successfully"