Send Status API

Table of Contents
Overview
Attributes
Get the status of a send
Update the status of a send

Overview

This API is used to query and update the status of a Send.

Attributes

The following attributes are defined for sends:

send
hash

id
integer

An automatically generated identifier.

sendid
string

The SendID for this send.

status
string

The send status.

normal	The send is delivering in a normal state.
pause	The send has been paused. See Pausing and Dumping Queues for more information.
dump	The send is being dumped. See Pausing and Dumping Queues for more information.

Get the status of a send

GET /ga/api/v3/eng/sends_by_sendid/{sendid}/status
GET /ga/api/v3/eng/sends/{id}/status

Parameters

sendid string	The SendID for the send you want to query.
id string	The primary key identifier for the send you want to query.

Response

See the attributes section above.

Example

GET /ga/api/v3/eng/sends_by_sendid/foo123/status

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "send": {
      "id": 7,
      "sendid": "foo123",
      "status": "normal"
    }
  },
  "error_code": null,
  "error_messages": null
}

Update the status of a send

POST /ga/api/v3/eng/sends_by_sendid/{sendid}/status
POST /ga/api/v3/eng/sends/{id}/status

Payload

send
hash

status
string

The status as described in the attributes section above.

Response

See the attributes section above.

Example

POST /ga/api/v3/eng/sends/2/status

{
  "send": {
    "status": "pause"
  }
}

HTTP/1.1 200 OK

{
  "success": true,
  "data": {
    "send": {
      "id": 2,
      "sendid": "foo123",
      "status": "pause"
    }
  },
  "error_code": null,
  "error_messages": null
}