Skip to main content
POST
/
accounts
/
self
/
contact-groups
const axios = require('axios');
const ContactsApiFp = require('@alohi/faxplus-api').ContactsApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function createContactGroup() {
    const groupData = {
        name: 'VIP Clients',
        description: 'Important customer group'
    };
    const req = await ContactsApiFp(config).createContactGroup({
        userId: 'self',
        body: groupData
    });
    const resp = await req(axios);
}

createContactGroup()

{
  "id": "5f7a8b9c0d1e2f3a4b5c6d7f",
  "name": "VIP Clients",
  "notes": "Important clients only",
  "is_shared": true,
  "creation_date": "2024-01-10T09:00:00Z",
  "modification_date": "2024-02-15T11:20:00Z"
}
const axios = require('axios');
const ContactsApiFp = require('@alohi/faxplus-api').ContactsApiFp;
const Configuration = require('@alohi/faxplus-api').Configuration;

const config = new Configuration({
    accessToken: accessToken,
    basePath: 'https://restapi.fax.plus/v3',
    baseOptions: {
        headers: {
          "x-fax-clientid": clientId,
        }
    }
});

async function createContactGroup() {
    const groupData = {
        name: 'VIP Clients',
        description: 'Important customer group'
    };
    const req = await ContactsApiFp(config).createContactGroup({
        userId: 'self',
        body: groupData
    });
    const resp = await req(axios);
}

createContactGroup()

Authorizations

​
Authorization
string
header
required

Personal Access Token (PAT) is a Bearer token used for secure API calls. For direct API calls, the PAT is used in the Authorization header as 'Bearer {PAT}'. For MCP usage, configure your PAT in your MCP client settings (e.g., in your IDE's MCP server configuration) - authentication will be handled automatically.

Body

application/json
​
name
string
required

Group name

Example:

"VIP Clients"

​
notes
string

Additional notes or description for the group

Example:

"Important clients only"

​
shared
boolean

Whether to share group with corporate members

Example:

false

Response

Response containing a single group object

​
id
string

Group ID

Example:

"5f7a8b9c0d1e2f3a4b5c6d7f"

​
name
string

Group name

Example:

"VIP Clients"

​
notes
string

Additional notes or description for the group

Example:

"Important clients only"

​
is_shared
boolean

Whether group is shared with corporate members

Example:

true

​
creation_date
string

Date group was created

Example:

"2024-01-10T09:00:00Z"

​
modification_date
string

Date group was last modified

Example:

"2024-02-15T11:20:00Z"