json

{
  "WorkgroupActivityId": "WAID-12345-abc-123456",
  "DigitOrder": 2,
  "PhoneNumber": "+1234567890",
  "WorkgroupId": "WID-12345-abc-12345",
  "Type": "User",
  "ReferenceUserId": "USER-abc-456",
  "SmsNotification": true,
  "EmailNotification": true
}

{
  "WorkgroupActivityStatus": "Updated",
  "WorkgroupActivityId": "WAID-12345-abc-123456"
}

Workgroups

Update Workgroup Activity

Update the configuration of a member within a workgroup. A workgroup activity represents an individual agent, destination, or nested workgroup within a ring group. Modify fields such as dial order (DigitOrder), forwarding number, or notification preferences. Requires the WorkgroupActivityId (WAID-) of the activity to update.

What this does: Returns the updated activity record. Use this to change a member’s ring order, SIP details, or timeout settings within the workgroup.

Next steps:

Confirm the update — GET /v1.0/workgroups
Remove the member — POST /v1.0/workgroups/activity/delete

POST

v1.0

workgroups

activity

update

json

{
  "WorkgroupActivityId": "WAID-12345-abc-123456",
  "DigitOrder": 2,
  "PhoneNumber": "+1234567890",
  "WorkgroupId": "WID-12345-abc-12345",
  "Type": "User",
  "ReferenceUserId": "USER-abc-456",
  "SmsNotification": true,
  "EmailNotification": true
}

{
  "WorkgroupActivityStatus": "Updated",
  "WorkgroupActivityId": "WAID-12345-abc-123456"
}

Body

application/json

WorkgroupActivityId

string

required

Unique identifier of the workgroup activity to update

Example:

"WAID-12345-abc-123456"

DigitOrder

integer

IVR digit or ring order position

Example:

2

PhoneNumber

string

Phone number to ring or forward to for this activity. Use E.164 format (e.g., +15555555555).

Example:

"+1234567890"

WorkgroupId

string

Parent workgroup ID

Example:

"WID-12345-abc-12345"

Type

enum<string>

Member type

Available options:

User,

Workgroup

ReferenceWorkgroupId

string

Referenced workgroup ID

ReferenceUserId

string

Referenced user ID

SmsNotification

boolean

Enable SMS notification

EmailNotification

boolean

Enable email notification

Response

Workgroup Activity Updated

The response is of type object.

Create Workgroup Activity Delete Workgroup Activity

⌘I