Create Group

POST/api/v2/groups

Use it in a workflow

Add a step and choose the Zendesk connector.
Pick the Create Group action (under Groups).
Fill in the fields below, then reference the result from later steps as {{createGroup.response.data}}.

Request

Request body

Enter the body as JSON in the step's Body field.

groupobjectrequired

descriptionstring

The description of the group

is_publicboolean

If true, the group is public. If false, the group is private. You can't change a private group to a public group

namestringrequired

The name of the group

json

{
  "group": {
    "name": "Support Team",
    "description": "Handles all customer support tickets",
    "is_public": true
  }
}

Response

Returns 201 with an object. Read it in later steps with {{createGroup.response.data.<field>}}.

groupobject

created_atstring (date-time)

The time the group was created

defaultboolean

If the group is the default one for the account

deletedboolean

Deleted groups get marked as such

descriptionstring

The description of the group

idinteger (int64)

Automatically assigned when creating groups

is_publicboolean

If true, the group is public. If false, the group is private. You can't change a private group to a public group

namestringrequired

The name of the group

updated_atstring (date-time)

The time of the last update of the group

urlstring

The API url of the group

json

{
  "group": {
    "created_at": "2009-07-20T22:55:29Z",
    "default": true,
    "deleted": false,
    "description": "Some clever description here",
    "id": 3432,
    "is_public": true,
    "name": "First Level Support",
    "updated_at": "2011-05-05T10:38:52Z",
    "url": "https://company.zendesk.com/api/v2/groups/3432"
  }
}

Need more? See the Zendesk guide for connection setup and behaviour shared by every action.

Was this page helpful?