Create

Create Single Group

POST - /v2/companies/<company_id>/groups

Required Properties

PropertyData TypeDescription
nameStringGroup Name
timezoneStringEx: America/Chicago

The default Timezone to use for things like scheduling outbound messages from projects in this group that don't specify their own Timezone.

List of valid options here

Optional Properties

PropertyData TypeDescription
colorString (Hex Value)Ex: #53A9FF
Color can be helpful as an additional categorical tool to signify something to the end user or help them quickly find a Group.
address_1StringThe first part of the Group's Address
address_2StringThe second part of the Group's Address
city_townStringThe City/Town for a Group
state_provinceStringThe State/Province for a Group
zipcodeStringZip/Postal Code for a Group
countryStringCountry for a Group
contact_nameStringIndividual who is the P.O.C. for the Group
contact_phoneStringPhone number for P.O.C.
Needs to have both country and area code.
contact_emailStringEmail address for P.O.C

Full Post Body Ex.

{
  "name": "West Coast - HQ",
  "timezone": "America/Los_Angeles",
  "color": "#53A9FF",
  "address_1": "1111 S Figueroa St",
  "address_2": "Building 3",
  "city_town": "Los Angeles",
  "state_province": "CA",
  "zipcode": "90015",
  "country": "United States",
  "contact_name": "John Doe",
  "contact_number": "1-213-444-3535",
  "contact_email": "[email protected]"
}

Responses:

Successful Response

The successful creation of a group will return the newly created Group ID:

{"id": "2d2ad78e-c6de-467e-8413-c616b55294a5"}


What’s Next