URL | https://api.xero.com/api.xro/2.0/ContactGroups |
Methods Supported | GET, PUT, POST, DELETE |
Description | Allows you to retrieve the ContactID and Name of all the contacts in a contact group
Allows you to create contact groups Allows you to rename contact groups Allows you to update the status (delete) contact groups Allows you to add contacts to a contact group Allows you to remove a contact from a contact group Allows you to remove all contacts from a contact group |
The following elements are returned in a ContactGroups response
Name | The Name of the contact group. Required when creating a new contact group |
Status | The Status of a contact group. Only contact groups with a status of ACTIVE are returned on GETs. |
ContactGroupID | The Xero generated unique identifier for contact groups |
Contacts | The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL. |
ContactGroupID | The Xero identifier for an contact group |
Where | Filter by an any element ( see Filters ) |
order | Order by any element returned ( see Order By ) |
Example response for GET ContactGroups
GET https://api.xero.com/api.xro/2.0/ContactGroups
Example response for retrieving a single ContactGroup
GET https://api.xero.com/api.xro/2.0/ContactGroups/97bbd0e6-ab4d-4117-9304-d90dd4779199
Use this method to create or update contact groups
The following elements can be supplied in a POST request
Name | The Name of the contact group. Required when creating a new contact group |
Status | The Status of a contact group. To delete a contact group update the status to DELETED. |
Contacts | The ContactID and Name of Contacts in a contact group. Add Contacts to a ContactGroup using the PUT method. |
Example request to create a new contact group
POST https://api.xero.com/api.xro/2.0/ContactGroups
Example request to rename a contact group
POST https://api.xero.com/api.xro/2.0/ContactGroups/679382fd-7a71-4281-b013-0ff811ca87ab
Example request to delete a contact group
.POST https://api.xero.com/api.xro/2.0/ContactGroups/679382fd-7a71-4281-b013-0ff811ca87ab
The DELETE method is used to remove a contact from a contact group or remove all contacts from a contact group.
Remove a contact from a contact group
DELETE https://api.xero.com/api.xro/2.0/ContactGroups/b05466c8-dc54-4ff8-8f17-9d7008a2e44b/Contacts/c7500d1a-7ff3-4099-bae3-8ecc45240a29
Remove all contacts from a contact group
DELETE https://api.xero.com/api.xro/2.0/ContactGroups/b05466c8-dc54-4ff8-8f17-9d7008a2e44b/Contacts