Skip to navigation

Create On Demand

Fire a one-off ad-hoc push or email notification batch for the organization without a persistent placement. Pin the audience with exactly one of placementId or offerIds (supplying both or neither is rejected). Rate limited to once per 24 hours per issuer: a request inside the window returns 429 with a Retry-After header indicating how many seconds to wait. On success the workflow is triggered and a 202 is returned with the recorded request id.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

organizationIdstringRequired
Unique identifier of the organization

Request

On-demand placement fire parameters

dataobjectRequired

On-demand placement fire parameters

Response

The ad-hoc request was accepted and the workflow was triggered

dataobject

The accepted on-demand placement request resource

Errors

400
Invalid Request
401
Unauthorized Error
403
Forbidden Error
404
Does Not Exist Error
429
Too Many Requests Error
500
Internal Server Error