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.

Headers

Trio-Version
enum<string>
required

Version of the v2 contract the client is written against. Each breaking change publishes a new version.

Available options:
2026-10-19.v2
Trio-Target-Org-Id
string<uuid>

ID of another org to act on instead of the API key's own org. The key's org must have been granted access to it, and the request is refused with 403 FORBIDDEN otherwise. When that access or the API key is read-only, only GET and HEAD requests may carry it. When the target org requires mTLS, so does the request. Leave it out to act on the key's own org.

Path Parameters

id
string<uuid>
required

Collection ID Unique identifier

Body

application/json

The collection schedule attributes

Body params to schedule a collection

amount
integer

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

Required range: x >= 1
due_date
string<date> | null

Day the attempt is due

external_id
string | null

External ID of the attempt

Response

No Content