Create

Create Single Group

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

Required Properties

Property

Data Type

Description

name

String

Group Name

timezone

String

Ex: 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

Property

Data Type

Description

color

String (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_1

String

The first part of the Group's Address

address_2

String

The second part of the Group's Address

city_town

String

The City/Town for a Group

state_province

String

The State/Province for a Group

zipcode

String

Zip/Postal Code for a Group

country

String

Country for a Group

contact_name

String

Individual who is the P.O.C. for the Group

contact_phone

String

Phone number for P.O.C.
Needs to have both country and area code.

contact_email

String

Email 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": "j.doe@laborchart.com"
}

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