Skip to main content
POST
/
v1.0
/
workgroups
/
activity
json
{
  "DigitOrder": 1,
  "PhoneNumber": "+1234567890",
  "WorkgroupId": "WID-12345-abc-12345",
  "Type": "Workgroup",
  "ReferenceWorkgroupId": "WID-12345-abc-12345",
  "ReferenceUserId": "",
  "SmsNotification": true,
  "EmailNotification": false
}
{
  "WorkgroupActivityStatus": "Created",
  "WorkgroupActivityId": "WAID-4dec6beb-3985-444b-8c06-8baa70dc1416"
}

Authorizations

​
Authorization
string
header
required

Enter the token obtained from the Authentication endpoint

Body

application/json
​
WorkgroupId
string
required

Parent workgroup ID to add this activity to

Example:

"WID-12345-abc-12345"

​
Type
enum<string>
required

Member type - User or nested Workgroup

Available options:
User,
Workgroup
Example:

"Workgroup"

​
DigitOrder
integer

IVR digit or ring order position for this member

Example:

1

​
PhoneNumber
string

Phone number for this activity member (E.164 format)

Example:

"+1234567890"

​
ReferenceWorkgroupId
string

Referenced workgroup ID (when Type is Workgroup)

Example:

"WID-12345-abc-12345"

​
ReferenceUserId
string

Referenced user ID (when Type is User)

​
SmsNotification
boolean

Enable SMS notification for this member

Example:

true

​
EmailNotification
boolean

Enable email notification for this member

Example:

false

Response

200 - application/json

Workgroup Activity Created

The response is of type object.