Skip to main content
POST
/
v1.0
/
workgroups
/
activity
json
{
  "DigitOrder": 1,
  "WorkgroupId": "WID-12345-abc-12345",
  "Type": "Workgroup",
  "PhoneNumber": "+1234567890",
  "SmsNotification": true
}
{
  "WorkgroupActivityId": "WAID-12345-abc-123456",
  "DigitOrder": 1,
  "PhoneNumber": "+1234567890",
  "WorkgroupId": "WID-12345-abc-12345",
  "Type": "Workgroup",
  "ReferenceWorkgroupId": "",
  "ReferenceUserId": "",
  "SmsNotification": true,
  "EmailNotification": false
}

Authorizations

​
Authorization
string
header
required

Enter the token obtained from the Authentication endpoint

Body

application/json
​
DigitOrder
integer
required

IVR digit (e.g., Press 1)

Example:

1

​
WorkgroupId
string
required

Workgroup ID

Example:

"WID-12345-abc-12345"

​
Type
enum<string>
required

Activity type

Available options:
User,
Workgroup
Example:

"Workgroup"

​
PhoneNumber
string

Phone number (E.164)

Example:

"+1234567890"

​
ReferenceWorkgroupId
string

Reference workgroup ID

​
ReferenceUserId
string

Reference user ID

​
SmsNotification
boolean

Enable SMS notifications

Example:

true

​
EmailNotification
boolean

Enable email notifications

Example:

false

Response

200 - application/json

Create Workgroup Activity

The response is of type object.