Field Reference

Fields that can be passed to the Groups Resource

FieldDescriptionRequiredPossible Values
nameA unique name that describes the GroupYesAlphanumeric text
time_zoneCalls made to numbers associated with this group will be reported in the timezone specifiedYesTime Zone:
- Eastern
- Central
- Mountain
- Pacific

Click here for a complete list
group_owner_idGroup Owner of the GroupNo (unless set to 'required' in Organization configuration.Integer
rich_data_typeUsed to determine what level of caller detail should be retrieved.

- Basic - Name/Address
- Rich - Name/Address/Demographic*

*Rich data will result in additional charges
No, will default to Basic- Rich
- Basic
billing_group_idIf multiple billing configurations exist, this id must be submitted with Group creation requestsOnly when multiple billing configurations are setInteger
email_notificationsWill accept a comma delimited list of email addresses that will be notified whenever a call is receivedNoA comma delimited list of email addresses
customer_idAn open field that can be used to map the group to a customer within your own organizationNoInteger

The following fields will be returned in the response:

FieldDescription
idGroup's Unique Identifier
nameGroup's Name
time_zoneCalls made to numbers associated with this group will be reported in the timezone specified
rich_data_typeUsed to determine what level of caller detail should be retrieved.

- Basic - Name/Address
- Rich - Name/Address/Demographic*

*Rich data will result in additional charges
billing_group_idIf multiple billing configurations exist, this id must be submitted with Group creation requests
email_notificationsWill accept a comma delimited list of email addresses that will be notified whenever a call is received
customer_idAn open field that can be used to map the group to a customer within your own organization
tracking_javascriptJavaScript snippet that can be deployed to your website and landing pages to measure calls
statusGroup's current status. Possible values: Active / Cancelled
created_datetimeDate/Time of when the group was created
modified_datetimeDate/Time of the last time the group was modified