POST /customers/{id}/timeline

Creates a customer timeline comment or custom defined event.

Servers

https://api-sandbox.rebilly.com/organizations/{organizationId}
https://api.rebilly.com/organizations/{organizationId}

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	No	ID of the customer timeline custom event.
`extraData`	Object	No	Additional data.
`extraData.mentions`	Object	No	User mentions, or tags, in a timeline.
`extraData.actions[]`	Array	No	Actions available for a timeline message. If no actions are available, this field is empty.
`extraData.tables[]`	Array	No	Table data that is attached to the timeline message.
`extraData.tables[].type`	String	No	Valid values: `"two-columns"` `"one-columns"` `"list"` `"three-columns"`
`extraData.tables[].title`	String	No	Data table title.
`extraData.tables[].footer`	String	No	Data table footer.
`extraData.author`	Object	No	Author of the timeline message.
`extraData.author.userId`	String	No	ID of the author.
`extraData.author.userFullName`	String	No	Full name of the author.
`extraData.links[]`	Array	No	Links that are attached to a timeline message.
`extraData.links[].placeholder`	String	No
`extraData.links[].resourceId`	String	No	Unique resource ID.
`extraData.links[].resourceType`	String	No	Valid values: `"external"` `"transaction"` `"dispute"` `"subscription"` `"coupon"` `"kyc-document"` `"email-message"` `"invoice"`
`extraData.links[].externalUrl`	String	No
`_links[]`	Array	No	Related links.
`_links[].href`	String	No	Link URL.
`_links[].rel`	String	No	Type of link. Valid values: `"self"`
`customData`	Object	No	Timeline custom event data. Used with `custom-event` type. Transforms to `extraData` two-column table in response.
`triggeredBy`	String	No	Specifies who, or what, triggered the timeline event. Valid values: `"rebilly"` `"direct-api"` `"app"`
`occurredTime`	String	No	Date and time when the timeline message occurred.
`message`	String	No	Detailed message description.
`type`	String	No	Type of timeline message. Valid values: `"kyc-request-fulfilled"` `"transaction-declined"` `"payment-card-expiration-was-modified"` `"quote-expired"` `"order-churned"` `"transaction-discrepancy-found"` `"customer-tagged"` `"kyc-document-accepted"` `"invoice-voided"` `"quote-issued"` `"kyc-document-reviewed"` `"deposit-request-completed"` `"quote-created"` `"custom-event-processed"` `"subscription-trial-end-changed"` `"coupon-applied"` `"customer-requested-otp"` `"custom-event"` `"quickbooks-customer-created"` `"order-activated"` `"account-verification-requested"` `"customer-bank-account-blocked"` `"default-payment-instrument-changed"` `"email-message-sent"` `"order-downgraded"` `"transaction-abandoned"` `"kyc-document-rejected"` `"customer-merged"` `"subscription-resumed"` `"lead-source-changed"` `"transaction-canceled"` `"invoice-paid"` `"quote-recalled"` `"account-password-reset-requested"` `"order-canceled"` `"transaction-amount-discrepancy-found"` `"quote-rejected"` `"aml-list-was-possibly-matched"` `"customer-comment-created"` `"invoice-issued"` `"quote-canceled"` `"deposit-request-expired"` `"kyc-document-created"` `"quote-order-attached"` `"deposit-request-created"` `"order-trial-ended"` `"custom-fields-changed"` `"customer-created"` `"invoice-revenue-recognized"` `"deposit-request-started"` `"order-paid-early"` `"kyc-document-modified"` `"coupon-redeemed"` `"customer-untagged"` `"invoice-partially-refunded"` `"order-completed"` `"coupon-redemption-canceled"` `"subscription-paused"` `"experian-check-performed"` `"invoice-partially-paid"` `"invoice-past-due"` `"invoice-refunded"` `"invoice-reissued"` `"invoice-disputed"` `"transaction-voided"` `"invoice-abandoned"` `"transaction-refunded"` `"transaction-waiting-gateway"` `"payment-instrument-created"` `"primary-address-changed"` `"order-renewed"` `"quote-updated"` `"transaction-approved"` `"refund-was-reflected-in-invoices"` `"order-created"` `"payment-card-expired"` `"invoice-created"` `"order-reactivated"` `"customer-blocked"` `"payment-instrument-deactivated"` `"transaction-disputed"` `"customer-payment-card-blocked"` `"quickbooks-customer-task-failed"` `"transaction-reconciled"` `"order-upgraded"`
`customEventType`	String	No	Timeline custom event type. Used with `custom-event` type. This value must be defined using the Create customer timeline custom event type operation.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.