Skip to main content
POST
/
subscribers
/
{id}
/
block
Block a subscriber
curl --request POST \
  --url https://olive-gateway-a6ba.onrender.com/api/v1/subscribers/{id}/block \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "Suspicious activity detected"
}
'
{}

Authorizations

​
Authorization
string
header
required

API Key for third-party integrations (WhatsApp, Smart PAY, VULT). Format: 'Bearer olive_live_xxxxxxxxxxxxx'

Path Parameters

​
id
string
required

Subscriber ID

Body

application/json

Block reason

​
reason
string
required
Example:

"Suspicious activity detected"

Response

Block successful

The response is of type object.