logo

Create a quote timeline comment

Creates a quote timeline comment or custom defined event.

SecuritySecretApiKey or JWT
Request
path Parameters
id
required
string <= 50 characters ^[@~\-\.\w]+$

ID of the resource.

Request Body schema: application/json

Quote timeline resource.

message
string

Contents of the timeline message.

Responses
201

Quote timeline comment or custom defined event created.

Response Headers
Location
string <uri>

Location of the related resource.

Example: "https://api.rebilly.com/example"
Response Schema: application/json
id
string <= 50 characters

ID of the timeline message.

type
string

Type of timeline message.

Enum: "quote-created" "quote-issued" "quote-accepted" "quote-rejected" "quote-canceled" "quote-recalled" "quote-updated" "quote-expired" "quote-order-attached"
triggeredBy
string

Specifies who, or what, triggered the timeline message.

Enum: "rebilly" "app" "direct-api"
message
string

Contents of the timeline message.

object (TimelineExtraData)

Additional data.

Array of objects (TimelineAction) >= 0 items

Actions available for a timeline message. If no actions are available, this field is empty.

Array (>= 0 items)
action
string
redemptionId
string <= 50 characters

Unique resource ID.

Array of objects (TimelineTable) >= 0 items

Table data that is attached to the timeline message.

Array (>= 0 items)
type
string
title
string

Data table title.

footer
string

Data table footer.

Array of objects

Table data. Each array element represents a table row.

object

Author of the timeline message.

userFullName
string

Author's full name.

userId
string <= 50 characters

Author's user ID.

object

User mentions, or tags, in a timeline.

property name*
additional property
string
Array of objects

Links that are attached to a timeline message.

Array
resourceType
string
Enum: "kyc-document" "invoice" "subscription" "transaction" "email-message" "dispute" "coupon" "external"
resourceId
string (ResourceId) <= 50 characters

Unique resource ID.

placeholder
string
externalUrl
string
occurredTime
string <date-time>

Date and time when the timeline message occurred.

Array of objects (SelfLink)

Related links.

Array
href
string

Link URL.

rel
string

Type of link.

Value: "self"
401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

422

Invalid data sent.

post/quotes/{id}/timeline
Request samples
application/json
{
  • "message": "string"
}
Response samples
application/json
{
  • "id": "tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC",
  • "type": "quote-created",
  • "triggeredBy": "rebilly",
  • "message": "string",
  • "extraData": {
    },
  • "occurredTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}
➔ Next to Retrieve a quote timeline message