FAfax
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

Request

  • Base URL
    https://restapi.fax.plus/v3
  • URL
    https://restapi.fax.plus/v3/accounts/self/contacts/assign-groups
  • Auth
    • HTTP bearer
    • or OAuth 2
      Authorization code: https://accounts.fax.plus/login?response_type=code&client_id=YOUR_CLIENT_ID&redirect_uri=http://localhost&scope=all
      Token URL: https://accounts.fax.plus/token scopes: all

Request body

groupsstring[]

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

contact_idsstring[] required

Array of contact IDs to assign to the specified groups

sharedboolean

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

Response

Groups associated successfully

object required

Changes

No recorded changes to this operation across all 2 revisions of this API.