Sign in
latestOpenAPI 3.1.02026-08-13233474.8 KB

e920ac8ed225

Groups

Create Group

Create a new group belonging to the provided organization.

post/groups

Request body

namestring required

The name of the group.

descriptionstring

The user provided description of the group.

countryCode'US' | 'CA' | 'PR' required

The country code of the country the group is registered in.

organizationIdstring required

The organization this group belongs to.

Example request

{
  "countryCode": "US",
  "location": {
    "label": "Denver, CO, USA",
    "coordinates": {
      "lat": 39.7392358,
      "lng": -104.990251
    }
  }
}

Response

Returns the created group.

idstring required

The ID of the group.

type'group' required

The type of object the attached ID corresponds to.

namestring required

The name of the group.

descriptionstring

The user provided description of the group.

countryCode'US' | 'CA' | 'PR' required

The country code of the country the group is registered in.

activeboolean required

Whether or not the group is active.

organizationIdstring required

The organization this group belongs to.

timezonestring required

The timezone of the group. Represented as an IANA Zone ID.

createdAtstring required

An ISO-8601 string representing the date the group was created.

Example response

{
  "countryCode": "US",
  "location": {
    "label": "Denver, CO, USA",
    "coordinates": {
      "lat": 39.7392358,
      "lng": -104.990251
    }
  },
  "timezone": "America/Denver"
}