> This page is for version 2024-10-01 (default).
> For other versions, use one of these documentation indexes:
> - 2024-10-01 (default): https://docs.getkard.com/2024-10-01/llms.txt
> - Legacy: https://docs.getkard.com/legacy/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.getkard.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.getkard.com/_mcp/server.

# Create On Demand

POST https://rewards-api.getkard.com/v2/issuers/{organizationId}/placements/onDemand
Content-Type: application/json

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.

Reference: https://docs.getkard.com/api/organizations/placements/create-on-demand

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Servers

- `https://rewards-api.getkard.com` (Production, default)
- `https://test-rewards-api.getkard.com` (Sandbox)

## Request

### Path parameters

- `organizationId` (string, required) — Unique identifier of the organization

### Body (application/json)

This endpoint expects a CreateOnDemandPlacementRequestBody.

- `data` (CreateOnDemandPlacementData, required) — On-demand placement fire parameters

## Response

### 202

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

- `data` (OnDemandPlacementResource, required) — The accepted on-demand placement request resource

## Errors

### 401 Unauthorized Error

- `errors` (list of ErrorObject, required)

### 403 Forbidden Error

- `errors` (list of ErrorObject, required)

### 400 Invalid Request

- `errors` (list of ErrorObject, required)

### 404 Does Not Exist Error

- `errors` (list of ErrorObject, required)

### 429 Too Many Requests Error

The issuer's traffic grew faster than its allowed rate, or the endpoint's own limit was reached. If the response includes a `Retry-After` header, wait that many seconds before retrying. See [Rate Limits](/2024-10-01/api/integration-guides/rate-limits).

- `errors` (list of ErrorObject, required)

### 500 Internal Server Error

- `errors` (list of ErrorObject, required)

## Types

### CreateOnDemandPlacementData

JSON:API data envelope for an on-demand placement fire

- `type` (string, required) — JSON:API resource type discriminant; always `placementOnDemand`.
- `attributes` (CreateOnDemandPlacementAttributes, required) — Attributes for an on-demand placement fire

### OnDemandPlacementResource

The accepted on-demand placement request resource

- `type` (string, required) — JSON:API resource type discriminant; always `placementOnDemand`.
- `id` (string, required) — Identifier of the recorded ad-hoc placement request (the request id).
- `attributes` (OnDemandPlacementResourceAttributes, required) — Attributes of an accepted on-demand placement request

### ErrorObject

- `status` (string, required) — Status code returned from the request
- `title` (string, required) — Name of error
- `detail` (string, required) — Description of the specific occurance of the error
- `source` (ErrorSource, optional) — An object containing a reference to the primary source of the error
- `id` (string, optional) — The id of the resource which caused the error. Always returned for multi-status errors.

### CreateOnDemandPlacementAttributes

Attributes for an on-demand placement fire

- `medium` (enum, required) — Delivery medium for the fire (`push` or `email`)
  - Allowed values: `push`, `email`
- `placementId` (string, optional) — ID of an existing placement to fire. Mutually exclusive with `offerIds`; provide exactly one.
- `offerIds` (list of string, optional) — IDs of the specific offers to pin the fire to (at least one). Mutually exclusive with `placementId`; provide exactly one.

### OnDemandPlacementResourceAttributes

Attributes of an accepted on-demand placement request

- `status` (enum, required) — Processing status of the request; `queued` when accepted.
  - Allowed values: `queued`

### ErrorSource

- `pointer` (string, optional) — A JSON pointer to the value in the request document that caused the error
- `parameter` (string, optional) — A string indicating which URI query parameter caused the error
- `header` (string, optional) — A string indicating the name of a single request header which caused the error

## Examples

### Fire by placement

**Request**

```json
{
  "data": {
    "type": "placementOnDemand",
    "attributes": {
      "medium": "push",
      "placementId": "01961e5a-b74c-7d42-8456-d3a1f2c90e71"
    }
  }
}
```

**Response**

```json
{
  "data": {
    "type": "placementOnDemand",
    "id": "01961e5a-c83d-7a11-9b2e-e7f4a6d81b34",
    "attributes": {
      "status": "queued"
    }
  }
}
```

**SDK Code**

```python Fire by placement
import requests

url = "https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand"

payload = { "data": {
        "type": "placementOnDemand",
        "attributes": {
            "medium": "push",
            "placementId": "01961e5a-b74c-7d42-8456-d3a1f2c90e71"
        }
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Fire by placement
const url = 'https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"data":{"type":"placementOnDemand","attributes":{"medium":"push","placementId":"01961e5a-b74c-7d42-8456-d3a1f2c90e71"}}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Fire by placement
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand"

	payload := strings.NewReader("{\n  \"data\": {\n    \"type\": \"placementOnDemand\",\n    \"attributes\": {\n      \"medium\": \"push\",\n      \"placementId\": \"01961e5a-b74c-7d42-8456-d3a1f2c90e71\"\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Fire by placement
require 'uri'
require 'net/http'

url = URI("https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"type\": \"placementOnDemand\",\n    \"attributes\": {\n      \"medium\": \"push\",\n      \"placementId\": \"01961e5a-b74c-7d42-8456-d3a1f2c90e71\"\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java Fire by placement
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"type\": \"placementOnDemand\",\n    \"attributes\": {\n      \"medium\": \"push\",\n      \"placementId\": \"01961e5a-b74c-7d42-8456-d3a1f2c90e71\"\n    }\n  }\n}")
  .asString();
```

```php Fire by placement
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand', [
  'body' => '{
  "data": {
    "type": "placementOnDemand",
    "attributes": {
      "medium": "push",
      "placementId": "01961e5a-b74c-7d42-8456-d3a1f2c90e71"
    }
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Fire by placement
using RestSharp;

var client = new RestClient("https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"data\": {\n    \"type\": \"placementOnDemand\",\n    \"attributes\": {\n      \"medium\": \"push\",\n      \"placementId\": \"01961e5a-b74c-7d42-8456-d3a1f2c90e71\"\n    }\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Fire by placement
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["data": [
    "type": "placementOnDemand",
    "attributes": [
      "medium": "push",
      "placementId": "01961e5a-b74c-7d42-8456-d3a1f2c90e71"
    ]
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Fire by offer

**Request**

```json
{
  "data": {
    "type": "placementOnDemand",
    "attributes": {
      "medium": "email",
      "offerIds": [
        "629fc220b7a4290009a188ec"
      ]
    }
  }
}
```

**Response**

```json
{
  "data": {
    "type": "placementOnDemand",
    "id": "01961e5a-c83d-7a11-9b2e-e7f4a6d81b34",
    "attributes": {
      "status": "queued"
    }
  }
}
```

**SDK Code**

```python Fire by offer
import requests

url = "https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand"

payload = { "data": {
        "type": "placementOnDemand",
        "attributes": {
            "medium": "email",
            "offerIds": ["629fc220b7a4290009a188ec"]
        }
    } }
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript Fire by offer
const url = 'https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"data":{"type":"placementOnDemand","attributes":{"medium":"email","offerIds":["629fc220b7a4290009a188ec"]}}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go Fire by offer
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand"

	payload := strings.NewReader("{\n  \"data\": {\n    \"type\": \"placementOnDemand\",\n    \"attributes\": {\n      \"medium\": \"email\",\n      \"offerIds\": [\n        \"629fc220b7a4290009a188ec\"\n      ]\n    }\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby Fire by offer
require 'uri'
require 'net/http'

url = URI("https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"data\": {\n    \"type\": \"placementOnDemand\",\n    \"attributes\": {\n      \"medium\": \"email\",\n      \"offerIds\": [\n        \"629fc220b7a4290009a188ec\"\n      ]\n    }\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java Fire by offer
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"data\": {\n    \"type\": \"placementOnDemand\",\n    \"attributes\": {\n      \"medium\": \"email\",\n      \"offerIds\": [\n        \"629fc220b7a4290009a188ec\"\n      ]\n    }\n  }\n}")
  .asString();
```

```php Fire by offer
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand', [
  'body' => '{
  "data": {
    "type": "placementOnDemand",
    "attributes": {
      "medium": "email",
      "offerIds": [
        "629fc220b7a4290009a188ec"
      ]
    }
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp Fire by offer
using RestSharp;

var client = new RestClient("https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"data\": {\n    \"type\": \"placementOnDemand\",\n    \"attributes\": {\n      \"medium\": \"email\",\n      \"offerIds\": [\n        \"629fc220b7a4290009a188ec\"\n      ]\n    }\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift Fire by offer
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = ["data": [
    "type": "placementOnDemand",
    "attributes": [
      "medium": "email",
      "offerIds": ["629fc220b7a4290009a188ec"]
    ]
  ]] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://rewards-api.getkard.com/v2/issuers/org-123/placements/onDemand")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```