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()
from faxplus import ApiClient, ContactsApi
from faxplus.configuration import Configuration
conf = Configuration()
conf.access_token = access_token
api_client = ApiClient(header_name='x-fax-clientid', header_value=client_id, configuration=conf)
api = ContactsApi(api_client)
associate_data = {
'contact_id': 'contact_123',
'group_ids': ['group_456', 'group_789']
}
resp = api.associate_contact_groups(user_id='self', body=associate_data)
curl -X POST https://restapi.fax.plus/v3/accounts/self/contacts/assign-groups \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'x-fax-clientid: "YOUR_CLIENT_ID"' \
-d '{
"contact_id": "contact_123",
"group_ids": ["group_456", "group_789"]
}'
{}{
"error": "invalid_user_id",
"description": "Invalid user id given"
}{
"error": "unauthorized",
"description": "The access token provided is expired, revoked, malformed, or invalid for other reasons."
}{
"error": "internal_server_error",
"description": "An unexpected error happened, please contact support"
}Contacts
Assign contacts to groups
Assign multiple contacts to multiple groups. Important: This operation overwrites existing group assignments for the specified contacts - it does not append to them. Contacts will be unassigned from any group that’s not included in this list (Permitted scopes: fax:all:edit)
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()
from faxplus import ApiClient, ContactsApi
from faxplus.configuration import Configuration
conf = Configuration()
conf.access_token = access_token
api_client = ApiClient(header_name='x-fax-clientid', header_value=client_id, configuration=conf)
api = ContactsApi(api_client)
associate_data = {
'contact_id': 'contact_123',
'group_ids': ['group_456', 'group_789']
}
resp = api.associate_contact_groups(user_id='self', body=associate_data)
curl -X POST https://restapi.fax.plus/v3/accounts/self/contacts/assign-groups \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'x-fax-clientid: "YOUR_CLIENT_ID"' \
-d '{
"contact_id": "contact_123",
"group_ids": ["group_456", "group_789"]
}'
{}{
"error": "invalid_user_id",
"description": "Invalid user id given"
}{
"error": "unauthorized",
"description": "The access token provided is expired, revoked, malformed, or invalid for other reasons."
}{
"error": "internal_server_error",
"description": "An unexpected error happened, please contact support"
}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()
from faxplus import ApiClient, ContactsApi
from faxplus.configuration import Configuration
conf = Configuration()
conf.access_token = access_token
api_client = ApiClient(header_name='x-fax-clientid', header_value=client_id, configuration=conf)
api = ContactsApi(api_client)
associate_data = {
'contact_id': 'contact_123',
'group_ids': ['group_456', 'group_789']
}
resp = api.associate_contact_groups(user_id='self', body=associate_data)
curl -X POST https://restapi.fax.plus/v3/accounts/self/contacts/assign-groups \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'x-fax-clientid: "YOUR_CLIENT_ID"' \
-d '{
"contact_id": "contact_123",
"group_ids": ["group_456", "group_789"]
}'
Authorizations
personal_access_tokenoauth2
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
Array of contact IDs to assign to the specified groups
Array of group names to assign to the contacts. This overwrites existing group assignments - contacts will be unassigned from any group that's not included in this list
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.