POST /payout-requests/{id}/timeline

Creates a payout request timeline comment.

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	Yes	ID of the message.
`extraData`	Object	Yes	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
`triggeredBy`	String	Yes	Who or what triggered this event. Valid values: `"rebilly"` `"direct-api"` `"app"`
`occurredTime`	String	Yes	Date and time when the timeline event occurred.
`message`	String	Yes	Human-readable message describing the timeline event.
`type`	String	Yes	Type of timeline event. Valid values: `"payout-request-approval-undone"` `"payout-request-processing-started"` `"payout-request-blocked"` `"payout-request-created"` `"payout-request-reversed"` `"timeline-comment-created"` `"payout-request-returned-to-pending"` `"payout-request-canceled"` `"payout-request-allocated"` `"payout-request-unblocked"` `"payout-request-fulfilled"` `"payout-request-ready"` `"payout-request-approved"`

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.