Update a group

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 updateContactGroup() {
    const updateData = {
        name: 'Premium Clients',
        description: 'Updated group description'
    };
    const req = await ContactsApiFp(config).updateContactGroup({
        userId: 'self',
        groupId: 'group_123',
        body: updateData
    });
    const resp = await req(axios);
}

updateContactGroup()

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)

update_data = {
    'name': 'Premium Clients',
    'description': 'Updated group description'
}

resp = api.update_contact_group(user_id='self', group_id='group_123', body=update_data)

curl -X PUT https://restapi.fax.plus/v3/accounts/self/contact-groups/group_123 \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'  \
  -H 'Authorization: Bearer {access-token}' \
  -H 'x-fax-clientid: "YOUR_CLIENT_ID"' \
  -d '{
    "name": "Premium Clients",
    "description": "Updated group description"
  }'

{
  "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": "bad_request",
  "description": "Requested resource was not found."
}

{
  "error": "internal_server_error",
  "description": "An unexpected error happened, please contact support"
}

PUT

accounts

self

contact-groups

{group_id}

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 updateContactGroup() {
    const updateData = {
        name: 'Premium Clients',
        description: 'Updated group description'
    };
    const req = await ContactsApiFp(config).updateContactGroup({
        userId: 'self',
        groupId: 'group_123',
        body: updateData
    });
    const resp = await req(axios);
}

updateContactGroup()

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)

update_data = {
    'name': 'Premium Clients',
    'description': 'Updated group description'
}

resp = api.update_contact_group(user_id='self', group_id='group_123', body=update_data)

curl -X PUT https://restapi.fax.plus/v3/accounts/self/contact-groups/group_123 \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'  \
  -H 'Authorization: Bearer {access-token}' \
  -H 'x-fax-clientid: "YOUR_CLIENT_ID"' \
  -d '{
    "name": "Premium Clients",
    "description": "Updated group description"
  }'

{
  "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": "bad_request",
  "description": "Requested resource was not found."
}

{
  "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 updateContactGroup() {
    const updateData = {
        name: 'Premium Clients',
        description: 'Updated group description'
    };
    const req = await ContactsApiFp(config).updateContactGroup({
        userId: 'self',
        groupId: 'group_123',
        body: updateData
    });
    const resp = await req(axios);
}

updateContactGroup()

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)

update_data = {
    'name': 'Premium Clients',
    'description': 'Updated group description'
}

resp = api.update_contact_group(user_id='self', group_id='group_123', body=update_data)

curl -X PUT https://restapi.fax.plus/v3/accounts/self/contact-groups/group_123 \
  -H 'Content-Type: application/json' \
  -H 'Accept: application/json'  \
  -H 'Authorization: Bearer {access-token}' \
  -H 'x-fax-clientid: "YOUR_CLIENT_ID"' \
  -d '{
    "name": "Premium Clients",
    "description": "Updated group description"
  }'

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.

Path Parameters

group_id

string

required

Group ID

Body

application/json

name

string

Group name

Maximum string length: 50

Example:

"Premium Clients"

notes

string

Additional notes or description for the group

Maximum string length: 100

Example:

"Updated notes"

Response

Response containing a single group object

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"

Create a group Delete a group

⌘I

Get Started

MCP

Concepts

SDKs

API Reference

Authorizations

Path Parameters

Body

Response