PUT /ContactGroups
Servers
- https://api.xero.com/api.xro/2.0
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
xero-tenant-id |
String | Yes |
Xero identifier for Tenant |
Idempotency-Key |
String | No |
This allows you to safely retry requests without the risk of duplicate processing. 128 character max. |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
ContactGroups[] |
Array | No | |
ContactGroups[].Name |
String | No |
The Name of the contact group. Required when creating a new contact group |
ContactGroups[].Status |
String | No |
The Status of a contact group. To delete a contact group update the status to DELETED. Only contact groups with a status of ACTIVE are returned on GETs. Possible values:
|
ContactGroups[].ContactGroupID |
String | No |
The Xero identifier for an contact group – specified as a string following the endpoint name. e.g. /297c2dc5-cc47-4afd-8ec8-74990b8761e9 |
ContactGroups[].Contacts[] |
Array | No |
The ContactID and Name of Contacts in a contact group. Returned on GETs when the ContactGroupID is supplied in the URL. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.