Vinix· docs
API referenceCore APIContact CenterRecipients

Bulk set recipient statuses

Sandbox is coming soon

Today, requests on this page run against your live account. A hosted sandbox with simulated PSTN is on the roadmap — until then, use a non-production user or callflow when experimenting.

Details
POST
/accounts/{account_id}/qubicle_recipients/status

Authorization

AuthToken
X-Auth-Token<token>

Obtain via PUT /v2/user_auth or PUT /v2/api_auth. See Authentication.

In: header

Path Parameters

account_id*string

Vinix account identifier.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

curl -X POST "https://example.com/accounts/string/qubicle_recipients/status" \  -H "Content-Type: application/json" \  -d '{    "data": {      "property1": {        "status": "login"      },      "property2": {        "status": "login"      }    }  }'
{}
{
  "message": "string",
  "request_id": "string"
}