Send Analytics Publication

Send a publication right now, outside its schedule. It reaches every recipient, outside addresses included, and cannot be taken back. A second call in the same minute is refused, so a retry never sends twice. Follow the send with List Analytics Publication Runs.

POST

Path

Path parameters

stringrequired

The page id, from List Analytics Pages.

stringrequired

The publication id, from List Analytics Publications.

Headers

Optional headers

string

Optional. The id of the organization to act in. Leave it out to act in the API key's own organization. Here a key acts in another organization only as one of its members: with "Use this key across all of your organizations" on, in an organization its creator belongs to with a role. Child organizations and MindCloud staff access do not reach this endpoint. Every response's X-Company-Id header names the organization it acted in. See Organizations.

Response fields

idstring

The send's id.

publicationIdstring

The publication it sent, from List Analytics Publications.

pageIdstring

The page it sent, from List Analytics Pages.

isManualboolean

True for a Send now, false for a scheduled send.

statusstring

How it went.

claimedStarting.
sendingBeing delivered.
sentDelivered.
failedCould not be delivered; errorCode and errorMessage say why.
missedIts scheduled time passed without a send.

statusOndate

When it reached its status.

recipientCountnumber

How many members it went to. Null before it is delivered.

externalRecipientCountnumber

How many outside addresses it went to. Null before it is delivered or with none.

errorCodestring

Why it failed. Null unless it failed.

errorMessagestring

What went wrong, in words. Null unless it failed.

createdOndate

When it started.