v1

latestOpenAPI 3.0.12026-07-2665150231.1 KB
Outbound

Set Activity State

Activates or deactivates a specified outbound

post/v1/Outbound/{outboundId}/Active

Path parameters

outboundIdstring required

The unique identifier of the outbound.

Retreive it in Get outbound

Request body

isActiveboolean required

A boolean value that specifies the new active status of the entity.

True activates the entity, while false deactivates it.

Response

The active state of the outbound.

integer required

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance