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>",
  "message": "<string>",
  "authorizationTimestamp": "2023-11-07T05:31:56Z",
  "system": "<string>",
  "externalId": "<string>",
  "attachments": [
    {
      "id": "<string>"
    }
  ],
  "links": [
    "<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>",
  "count": 123,
  "level": 123,
  "levelName": "<string>",
  "triggerAlert": true,
  "triggerReel": true,
  "triggerDonaton": true,
  "addToGoal": true,
  "addToTop": true
}
'

200

{
  "attributes": {
    "conversionService": {},
    "empty": true
  },
  "headers": {
    "conversionService": {},
    "empty": true,
    "keepAlive": true,
    "origin": "<string>",
    "authorization": "<string>",
    "contentType": "<string>"
  },
  "body": {},
  "characterEncoding": "<string>",
  "locale": "<string>",
  "contentType": {
    "name": "<string>",
    "parametersMap": {},
    "type": "<string>",
    "subtype": "<string>",
    "extension": "<string>",
    "parameters": {
      "empty": true
    },
    "quality": "<string>",
    "qualityAsNumber": 123,
    "version": "<string>",
    "charset": "<string>",
    "textBased": true
  },
  "bodyWriter": {
    "blocking": true
  },
  "contentLength": 123,
  "status": "CONTINUE",
  "cookies": {
    "conversionService": {},
    "empty": true,
    "all": [
      {
        "name": "<string>",
        "value": "<string>",
        "domain": "<string>",
        "path": "<string>",
        "httpOnly": true,
        "secure": true,
        "maxAge": 123,
        "sameSite": "Lax"
      }
    ]
  }
}

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

links · string[]

Attached media links

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

count · integer<int32> | null

Related item count

level · integer<int32> | null

Boosty subscription level

levelName · string | null

Boosty subscription level name

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 - application/json

Successfully created the history item

attributes · object · required

Show child attributes

headers · object · required

Show child attributes

body · object · required

characterEncoding · string · required

locale · string · required

contentType · object · required

Show child attributes

bodyWriter · object

Show child attributes

contentLength · integer<int64>

status · enum<string>

Available options: CONTINUE, SWITCHING_PROTOCOLS, PROCESSING, EARLY_HINTS, OK, CREATED, ACCEPTED, NON_AUTHORITATIVE_INFORMATION, NO_CONTENT, RESET_CONTENT, PARTIAL_CONTENT, MULTI_STATUS, ALREADY_IMPORTED, IM_USED, MULTIPLE_CHOICES, MOVED_PERMANENTLY, FOUND, SEE_OTHER, NOT_MODIFIED, USE_PROXY, SWITCH_PROXY, TEMPORARY_REDIRECT, PERMANENT_REDIRECT, BAD_REQUEST, UNAUTHORIZED, PAYMENT_REQUIRED, FORBIDDEN, NOT_FOUND, METHOD_NOT_ALLOWED, NOT_ACCEPTABLE, PROXY_AUTHENTICATION_REQUIRED, REQUEST_TIMEOUT, CONFLICT, GONE, LENGTH_REQUIRED, PRECONDITION_FAILED, REQUEST_ENTITY_TOO_LARGE, REQUEST_URI_TOO_LONG, UNSUPPORTED_MEDIA_TYPE, REQUESTED_RANGE_NOT_SATISFIABLE, EXPECTATION_FAILED, I_AM_A_TEAPOT, ENHANCE_YOUR_CALM, MISDIRECTED_REQUEST, UNPROCESSABLE_ENTITY, LOCKED, FAILED_DEPENDENCY, TOO_EARLY, UPGRADE_REQUIRED, PRECONDITION_REQUIRED, TOO_MANY_REQUESTS, REQUEST_HEADER_FIELDS_TOO_LARGE, NO_RESPONSE, BLOCKED_BY_WINDOWS_PARENTAL_CONTROLS, UNAVAILABLE_FOR_LEGAL_REASONS, REQUEST_HEADER_TOO_LARGE, INTERNAL_SERVER_ERROR, NOT_IMPLEMENTED, BAD_GATEWAY, SERVICE_UNAVAILABLE, GATEWAY_TIMEOUT, HTTP_VERSION_NOT_SUPPORTED, VARIANT_ALSO_NEGOTIATES, INSUFFICIENT_STORAGE, LOOP_DETECTED, BANDWIDTH_LIMIT_EXCEEDED, NOT_EXTENDED, NETWORK_AUTHENTICATION_REQUIRED, CONNECTION_TIMED_OUT

cookies · object

Show child attributes