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()
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)
group_data = {
'name': 'VIP Clients',
'description': 'Important customer group'
}
resp = api.create_contact_group(user_id='self', body=group_data)
curl -X POST https://restapi.fax.plus/v3/accounts/self/contact-groups \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'x-fax-clientid: "YOUR_CLIENT_ID"' \
-d '{
"name": "VIP Clients",
"description": "Important customer group"
}'
{
"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"
}{
"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
Create a group
Create a new contact group (Permitted scopes: fax:all:edit)
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()
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)
group_data = {
'name': 'VIP Clients',
'description': 'Important customer group'
}
resp = api.create_contact_group(user_id='self', body=group_data)
curl -X POST https://restapi.fax.plus/v3/accounts/self/contact-groups \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'x-fax-clientid: "YOUR_CLIENT_ID"' \
-d '{
"name": "VIP Clients",
"description": "Important customer group"
}'
{
"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"
}{
"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 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()
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)
group_data = {
'name': 'VIP Clients',
'description': 'Important customer group'
}
resp = api.create_contact_group(user_id='self', body=group_data)
curl -X POST https://restapi.fax.plus/v3/accounts/self/contact-groups \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
-H 'Authorization: Bearer {access-token}' \
-H 'x-fax-clientid: "YOUR_CLIENT_ID"' \
-d '{
"name": "VIP Clients",
"description": "Important customer group"
}'
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
Response
Response containing a single group object
Group ID
Example:
"5f7a8b9c0d1e2f3a4b5c6d7f"
Group name
Example:
"VIP Clients"
Additional notes or description for the group
Example:
"Important clients only"
Whether group is shared with corporate members
Example:
true
Date group was created
Example:
"2024-01-10T09:00:00Z"
Date group was last modified
Example:
"2024-02-15T11:20:00Z"