/
Create a customer timelin...

Create a customer timeline comment

Request

Creates a customer timeline comment or custom defined event.

Security
SecretApiKey or JWT
Path
idstring, <= 50 characters^[@~\-\.\w]+$required

ID of the resource.

Bodyapplication/jsonrequired

Customer timeline resource.

typestring

Type of timeline message.

Enum:"account-password-reset-requested""account-verification-requested""aml-list-was-possibly-matched""deposit-request-completed""deposit-request-created""deposit-request-expired""deposit-request-started""coupon-applied""coupon-redeemed""coupon-redemption-canceled"
customEventTypestring or null, [ 1 .. 255 ] characters

Timeline custom event type. Used with custom-event type. This value must be defined using the Create customer timeline custom event type operation.

customDataobjectwrite-only

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

Example:
{
  "customAttribute": "customValue",
  "otherAttribute": "otherValue"
}
messagestring

Detailed message description.

curl -i -X POST \
  'https://www.rebilly.com/_mock/catalog/all/customers/{id}/timeline' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "type": "account-password-reset-requested",
    "customEventType": "string",
    "customData": {
      "customAttribute": "customValue",
      "otherAttribute": "otherValue"
    },
    "message": "string"
  }'

Responses

Customer timeline comment or custom defined event created.

Headers
Locationstring, (uri)

Location of the related resource.

Example:"https://api.rebilly.com/example"
X-RateLimit-Limitinteger

Total number of rate limit tokens for this request within a rate limit period. For more information, see Rate limits.

Example:3600
X-RateLimit-Remaininginteger

Remaining number of rate limit tokens for this request within the rate limit period. For example, in the sandbox environment, rate limits for non-GET endpoints are set at 3000 requests per 10 minutes.

Example:3600
Bodyapplication/json
idstring, <= 50 charactersread-only

ID of the customer timeline custom event.

Example:"tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC"
typestring

Type of timeline message.

Enum:"account-password-reset-requested""account-verification-requested""aml-list-was-possibly-matched""deposit-request-completed""deposit-request-created""deposit-request-expired""deposit-request-started""coupon-applied""coupon-redeemed""coupon-redemption-canceled"
customEventTypestring or null, [ 1 .. 255 ] characters

Timeline custom event type. Used with custom-event type. This value must be defined using the Create customer timeline custom event type operation.

triggeredBystringread-only

Specifies who, or what, triggered the timeline event.

Enum:"rebilly""app""direct-api"
messagestring

Detailed message description.

extraDataobject(TimelineExtraData)read-only

Additional data.

occurredTimestring, (date-time)(ServerTimestamp)read-only

Date and time when the timeline message occurred.

Response
{
  "id": "tmln_0YV8Q9WEF5DTA8HFXS27D1G6GC",
  "type": "account-password-reset-requested",
  "customEventType": "string",
  "triggeredBy": "rebilly",
  "message": "string",
  "extraData": {
    "actions": [ … ],
    "tables": [ … ],
    "author": { … },
    "mentions": { … },
    "links": [ … ]
  },
  "occurredTime": "2019-08-24T14:15:22Z",
  "_links": [
    { … }
  ]
}