Skip to main content
POST
/
v1
/
Outbound
/
{outboundId}
/
Active
Set Activity State
curl --request POST \
  --url https://api.nlpearl.ai/v1/Outbound/{outboundId}/Active \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "isActive": true
}
'
123

Authorizations

​
Authorization
string
header
required

Specify the authorization token.

For more information, check out the Authorization Guide.

Path Parameters

​
outboundId
string
required

The unique identifier of the outbound.

Retreive it in Get outbound

Body

The request containing the activation state.

Defines the request structure for setting the active status of an entity.

​
isActive
boolean
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.

Here is the activity status

1 - Running

2 - Paused

3 - Suspended

10 - TemporaryMaintenance