Field Reference

Fields that can be passed to the Groups Resource

Field

Description

Required

Possible Values

name

A unique name that describes the Group

Yes

Alphanumeric text

time_zone

Calls made to numbers associated with this group will be reported in the timezone specified

Yes

Time Zone:

  • Eastern
  • Central
  • Mountain
  • Pacific

Click here for a complete list

group_owner_id

Group Owner of the Group

No (unless set to 'required' in Organization configuration.

Integer

rich_data_type

Used 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_id

If multiple billing configurations exist, this id must be submitted with Group creation requests

Only when multiple billing configurations are set

Integer

email_notifications

Will accept a comma delimited list of email addresses that will be notified whenever a call is received

No

A comma delimited list of email addresses

customer_id

An open field that can be used to map the group to a customer within your own organization

No

Integer

The following fields will be returned in the response:

Field

Description

id

Group's Unique Identifier

name

Group's Name

time_zone

Calls made to numbers associated with this group will be reported in the timezone specified

rich_data_type

Used 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_id

If multiple billing configurations exist, this id must be submitted with Group creation requests

email_notifications

Will accept a comma delimited list of email addresses that will be notified whenever a call is received

customer_id

An open field that can be used to map the group to a customer within your own organization

tracking_javascript

JavaScript snippet that can be deployed to your website and landing pages to measure calls

status

Group's current status. Possible values: Active / Cancelled

created_datetime

Date/Time of when the group was created

modified_datetime

Date/Time of the last time the group was modified