Skip to main content
POST
/
timeline_comments
Create a timeline comment
curl --request POST \
  --url https://app.supercycle.com/api/v1/timeline_comments \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "timelineEvent": {
    "eventableId": 123,
    "eventableType": "Item",
    "message": "<string>"
  }
}
'
{
  "id": 123,
  "eventableId": 123,
  "eventableType": "<string>",
  "eventType": "comment",
  "message": "<string>"
}

Authorizations

Authorization
string
header
required

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

Body

application/json
timelineEvent
object
required

Response

Successfully created timeline comment

id
integer<int64>
required

Numeric ID of the timeline event.

eventableId
integer<int64>
required

Numeric ID of the resource associated with the event.

eventableType
string
required

Type of the resource (e.g., Item, Rental, ReturnOrder).

eventType
enum<string>
required

Type of the timeline event.

Available options:
comment
message
string
required

The comment message associated with the timeline event.