Skip to main content
POST
/
accounts
/
self
/
contacts
/
assign-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 associateContactGroups() {
    const associateData = {
        contact_id: 'contact_123',
        group_ids: ['group_456', 'group_789']
    };
    const req = await ContactsApiFp(config).associateContactGroups({
        userId: 'self',
        body: associateData
    });
    const resp = await req(axios);
}

associateContactGroups()

{}
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 associateContactGroups() {
    const associateData = {
        contact_id: 'contact_123',
        group_ids: ['group_456', 'group_789']
    };
    const req = await ContactsApiFp(config).associateContactGroups({
        userId: 'self',
        body: associateData
    });
    const resp = await req(axios);
}

associateContactGroups()

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
​
contact_ids
string[]
required

Array of contact IDs to assign to the specified groups

​
groups
string[]

Array of group IDs to assign to the contacts. This overwrites existing group assignments - contacts will be unassigned from any group that's not included in this list

​
shared
boolean
default:false

If true, operate on shared/corporate contacts and groups. If false, operate on personal contacts and groups

Response

Groups associated successfully

The response is of type object.