Lalexi
APIСправочникBroadcasts

Change one recipient

Changes what one recipient gets, or when; the text is saved before the time. An administrator may do this to any broadcast; anyone else only when the items it touches go out from numbers they work in (403 forbidden otherwise).

PATCH
/broadcasts/{broadcast_id}/items/{id}

Authorization

personalToken
AuthorizationBearer <token>

Your personal access token from Profile → Access Token in Lalexi. It acts with exactly your role: what you may see and do in the workspace, and nothing more. Everything done with it is recorded as done by you.

In: header

Path Parameters

broadcast_id*integer

The broadcast's id.

id*integer

The item's id.

Header Parameters

X-Workspace-Id?integer

The workspace to work in (an id from GET /me). Optional when you belong to a single workspace; required otherwise (400 workspace_required).

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://app.lalexi.com/v1/broadcasts/0/items/0" \  -H "X-Workspace-Id: 7" \  -H "Content-Type: application/json" \  -d '{}'
{
  "id": 0,
  "channel_id": 0,
  "phone": "string",
  "chat_id": "string",
  "name": "string",
  "text": "string",
  "rephrased_text": "string",
  "status": "pending",
  "error_code": "message_limit_reached",
  "delay_seconds": 0,
  "scheduled_at": "2019-08-24T14:15:22Z",
  "sent_at": "2019-08-24T14:15:22Z"
}
{
  "error": {
    "code": "workspace_required",
    "message": "You belong to several workspaces: pass the X-Workspace-Id header."
  }
}
{
  "error": {
    "code": "invalid_api_key",
    "message": "The API key is missing or invalid."
  }
}
{
  "error": {
    "code": "forbidden",
    "message": "You are not allowed to do this."
  }
}
{
  "error": {
    "code": "not_found",
    "message": "Resource not found."
  }
}
{
  "error": {
    "code": "validation_failed",
    "message": "The request is invalid.",
    "details": {
      "email": [
        "is invalid"
      ]
    }
  }
}
{
  "error": {
    "code": "rate_limited",
    "message": "Too many requests. Retry after the number of seconds in Retry-After."
  }
}
{
  "error": {
    "code": "internal_error",
    "message": "Something went wrong on our side."
  }
}
{
  "error": {
    "code": "upstream_unavailable",
    "message": "The messaging service is unavailable. Nothing was sent; try again."
  }
}