Update an Existing Routine

put

https://api-sandbox.astra.finance/v1/routines/{id}

📘
You can place the bearer access_token for a specific user into the Authentication section of this documentation 👉.

This endpoint updates an existing Routine for a User.

🚧
Routine types may not be changed. Any of the non-required parameters below may be updated with this endpoint, provided they are included in the model for that Routine type.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

string

required

The unique ID of Routine

Body Params

name

string

The name given for the Routine

payment_type

string

enum

The type of Payment

Allowed:

active

boolean

Whether the routine is active (True) or paused (False). Defaults to True.

source_id

string

The ID of the Source Account

destination_id

string

The ID of the Destination Account

amount

float

The amount of the transfer (when explicitly defined like one-time or recurring)

start_date

date-time

The date the Routine should start processing (timezone is "America/Los_Angeles")

preferred_settlement_speed

string

enum

The requested settlement speed for resulting transfers

Allowed:

frequency

string

enum

The frequency a repeating Routine should process

Allowed:

client_correlation_id

string

An optional correlation id that will be added to ACH Addenda. This will also be included in the Transfer response.

Responses

Language

Credentials

Bearer

URL

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successful response

400Bad Request

401Unauthorized

404Not Found