/
Create a payout request t...

Create a payout request timeline comment
Experimental

Request

Creates a payout request timeline comment.

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

ID of the resource.

Bodyapplication/jsonrequired

Payout request timeline resource.

messagestringrequired

Human-readable message describing the timeline event.

curl -i -X POST \
  'https://www.rebilly.com/_mock/catalog/all/payout-requests/{id}/timeline' \
  -H 'Content-Type: application/json' \
  -H 'REB-APIKEY: YOUR_API_KEY_HERE' \
  -d '{
    "message": "string"
  }'

Responses

Payout request timeline comment 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-onlyrequired

ID of the message.

Example:"tlm_0YVDMDE2BMC6KBB5MX76RF6T80"
typestringread-onlyrequired

Type of timeline event.

Enum:"timeline-comment-created""payout-request-created""payout-request-ready""payout-request-returned-to-pending""payout-request-approved""payout-request-approval-undone""payout-request-allocated""payout-request-processing-started""payout-request-fulfilled""payout-request-canceled"
occurredTimestring, (date-time)(ServerTimestamp)read-onlyrequired

Date and time when the timeline event occurred.

triggeredBystringread-onlyrequired

Who or what triggered this event.

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

Human-readable message describing the timeline event.

extraDataobject(TimelineExtraData)read-onlyrequired

Additional data.

Response
{
  "id": "tlm_0YVDMDE2BMC6KBB5MX76RF6T80",
  "type": "timeline-comment-created",
  "occurredTime": "2019-08-24T14:15:22Z",
  "triggeredBy": "rebilly",
  "message": "string",
  "extraData": {
    "actions": [ … ],
    "tables": [ … ],
    "author": { … },
    "mentions": { … },
    "links": [ … ]
  }
}