Create a customer Timeline comment or custom defined event

Create a customer Timeline comment or custom defined event.

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

The resource identifier string.

Request Body schema: application/json

Customer Timeline resource.

type
string

Timeline message type.

Enum: "account-password-reset-requested" "account-verification-requested" "aml-list-was-possibly-matched" "coupon-applied" "coupon-redeemed" "coupon-redemption-canceled" "custom-event" "custom-event-processed" "custom-fields-changed" "customer-bank-account-blocked" … 62 more
customEventType
string or null [ 1 .. 255 ] characters

Timeline custom event type. Used with custom-event type. Must be defined using Customer Timeline custom event API.

customData
object

Timeline custom event data. Used with custom-event type. Will be transformed to extraData two-column table in response.

message
string

The message that describes the message details.

Responses
201

Customer Timeline comment or custom defined event was created.

Response Headers
Location
string <uri>

The location of the related resource.

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

The Timeline message identifier string.

type
string

Timeline message type.

Enum: "account-password-reset-requested" "account-verification-requested" "aml-list-was-possibly-matched" "coupon-applied" "coupon-redeemed" "coupon-redemption-canceled" "custom-event" "custom-event-processed" "custom-fields-changed" "customer-bank-account-blocked" … 62 more
customEventType
string or null [ 1 .. 255 ] characters

Timeline custom event type. Used with custom-event type. Must be defined using Customer Timeline custom event API.

triggeredBy
string

Shows who or what triggered the Timeline message.

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

The message that describes the message details.

object (TimelineExtraData)

Additional data.

Array of objects (TimelineAction) >= 0 items

Actions available to a Timeline message. Can be empty in case no actions are available for a message.

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

The resource ID. Defaults to UUID v4.

Array of objects (TimelineTable) >= 0 items
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

Timeline comment author data.

userFullName
string
userId
string
object
property name*
additional property
string
Array of objects
Array
resourceType
string
Enum: "kyc-document" "invoice" "subscription" "transaction" "email-message" "dispute" "coupon" "external"
resourceId
string (ResourceId) <= 50 characters

The resource ID. Defaults to UUID v4.

placeholder
string
externalUrl
string
occurredTime
string <date-time>

Timeline message time.

Array of objects (Self) non-empty

The links related to resource.

Array (non-empty)
href
required
string

The link URL.

rel
required
string

The link type.

Value: "self"
401

Unauthorized access, invalid credentials were used.

403

Access forbidden.

422

Invalid data was sent.

post/customers/{id}/timeline
Request samples
application/json
{
  • "type": "account-password-reset-requested",
  • "customEventType": "string",
  • "customData": {
    },
  • "message": "string"
}
Response samples
application/json
{
  • "id": "4f6cf35x-2c4y-483z-a0a9-158621f77a21",
  • "type": "account-password-reset-requested",
  • "customEventType": "string",
  • "triggeredBy": "rebilly",
  • "message": "string",
  • "extraData": {
    },
  • "occurredTime": "2019-08-24T14:15:22Z",
  • "_links": [
    ]
}