Outbound

Set Activity State

Activates or deactivates a specified outbound

post/v1/Outbound/{outboundId}/Active

Request

Base URL
https://api.nlpearl.ai
Auth
HTTP bearer
TypeScript
https://skmtc.dev/nlpearl/apis/nlpearl-client-api/docs/v1/Outbound/:outboundId/Active/post.ts
A function with typed inputs. Its response is checked against the schema.

outboundIdstring required

The unique identifier of the outbound.

Retreive it in Get outbound

isActiveboolean required

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

True activates the entity, while false deactivates it.

The active state of the outbound.

integer required

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance

No recorded changes to this operation across all 1 revision of this API.