Add a new history item

Creates a new donation history item for the authenticated user

POST /history/commands/add-item

Add a new history item

cURL

curl --request POST \
  --url https://api.example.com/history/commands/add-item \
  --header 'Content-Type: application/json' \
  --data '
{
  "paymentId": "<string>",
  "nickname": "<string>",
  "recipientId": "<string>",
  "amount": {
    "minor": 123,
    "major": 123,
    "currency": "<string>"
  },
  "message": "<string>",
  "authorizationTimestamp": "2023-11-07T05:31:56Z",
  "system": "<string>",
  "externalId": "<string>",
  "attachments": [
    {
      "id": "<string>"
    }
  ],
  "goals": [
    {
      "goalId": "<string>",
      "goalTitle": "<string>"
    }
  ],
  "reelResults": [
    {
      "title": "<string>"
    }
  ],
  "actions": [
    {
      "id": "<string>",
      "actionId": "<string>",
      "name": "<string>",
      "amount": 123,
      "payload": {}
    }
  ],
  "alertMedia": {
    "url": "<string>"
  },
  "vote": {
    "id": "<string>",
    "name": "<string>",
    "isNew": true
  },
  "event": "<string>",
  "triggerAlert": true,
  "triggerReel": true,
  "triggerDonaton": true,
  "addToGoal": true,
  "addToTop": true
}
'

Body

application/json

Command to add a new history item

paymentId · string | null

Payment ID from the source system

nickname · string

Donor's nickname

recipientId · string

Recipient ID (streamer/creator)

amount · object

Donation amount

Show child attributes

message · string

Message from the donor

authorizationTimestamp · string<date-time>

Authorization timestamp

system · string

Source system name

externalId · string | null

External ID from the source system

attachments · object[]

Attached media files

Show child attributes

goals · object[]

Target goals

Show child attributes

reelResults · object[]

Reel results from social media

Show child attributes

actions · object[]

Action requests triggered by the donation

Show child attributes

alertMedia · object

Alert media URL

Show child attributes

vote · object

Vote information

Show child attributes

event · string

Event type

triggerAlert · boolean

Whether to trigger an alert

triggerReel · boolean

Whether to trigger a reel

triggerDonaton · boolean

Whether to trigger donation processing

addToGoal · boolean

Whether to add to goal

addToTop · boolean

Whether to add to top

Response

200

Successfully created the history item