RuntimePOST

Refresh runtime state

Synchronizes the latest provider runtime state for an account. runtime_status takes one of the platform-standard values: unknown, starting, running, stopping, stopped, reconnecting, disconnected, error. Provider-specific labels are normalised into this set before being returned.

https://api.unifyport.ai/v1/accounts/{account_id}/runtime/refresh

Headers

X-Api-Key

stringrequired

Workspace API key. The workspace is resolved from this header.

Content-Type

stringrequired

Use application/json when sending a JSON request body.

Path parameters

account_id

stringrequired

Identifier used in the runtime route.

Request body

This endpoint accepts an empty JSON object; send {} exactly as shown in the request example.

Response body

account_id

string

Provider account this response refers to.

provider

string

Provider whose runtime handled the action.

enum: telegram, whatsapp, line, twitter, zalo, tiktok, whatsapp_protocol

action

string

Runtime action that was requested.

enum: refresh_status, start, stop, reconnect

operation_status

string

Whether the runtime action was accepted or completed.

runtime_status

string

Normalized runtime state: one of unknown, starting, running, stopping, stopped, reconnecting, disconnected, or error.

enum: unknown, starting, running, stopping, stopped, reconnecting, disconnected, error

runtime_error

string

Provider runtime error when the action could not complete.

Responses

200

200 OK

Request succeeded. See the example response body.

400

Bad Request

The request body, path, or parameters are invalid.

401

Unauthorized

The X-Api-Key header is missing or invalid.

409

Conflict

The requested operation conflicts with an existing provider account or resource.

500

Internal Server Error

The service encountered an unexpected error.

502

Bad Gateway

The provider adapter or upstream provider could not complete the operation.

Request

curl -X POST https://api.unifyport.ai/v1/accounts/{account_id}/runtime/refresh \
  -H "X-Api-Key: <YOUR_API_KEY>" \
  -H "Content-Type: application/json" \
  -d '{}'

Response

{
  "data": {
    "account_id": "acc_example",
    "runtime_status": "running"
  }
}