URI | Method | Returns | Notes |
/groups | GET | Array of groups | Get all groups. |
/groups | POST | A single group, with new GroupId. | Create a new group. You need to supply the group information as either XML or json. |
/groups/{id} | GET | A single group | Retrieve the information about a single group defined by the identifier. |
/groups/{id} | PUT | Status code 200, no content | Update a group based on the identifier. You need to supply the group information as either XML or json. |
/groups/{id} | DELETE | Status code 200, no content | Delete a group based on the identifier. |
/groups/{id}/contacts | GET | Array of contacts | Get all contacts in a group. |
/groups/{id}/contacts/{contactId} | PUT | Status code 200, no content | Use this to add an existing contacts to a group. New contacts are created using the contacts resource. |
/groups/{id}/contacts/{contactId} | DELETE | Status code 200, no content | Use this to remove a contacts from a group. The contact itself is not deleted by this operation. |
/groups/{id}/contacts/search/{text} | GET | Array of contacts | Used to search for contacts in a specific group. Searches in fields firstname, lastname, description, description2, description3, email, and phonenumber. You can provide multiple search terms, separated by space (%20). Contacts will then need to match on all provided terms. |