Skip to main content
POST
Schedule collection

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

id
string<uuid>
required

Collection ID Unique identifier

Body

application/json

The collection schedule attributes

Schedule update params

amount
integer

Collection Amount in cents. Use it for updating the collection amount before scheduling. Does not work on recurrences with fixed amount.

due_date
string<date-time> | null

attempt's due date

external_id
string | null

attempt's external_id

Response

No Content

The response is of type string<string>.

Example:

"No Content"