Scheduler

Delete a scheduled payment-link email

Cancels an email whose status is scheduled or failed: the customer will NOT be emailed about this payment link (its email mode becomes suppress); the link itself stays payable. A processing email cannot be cancelled because the provider outcome may already be in flight. A repeat answers not_found (already gone).

Requires an admin API key (has side effects).

delete/v1/scheduled-emails/{scheduledEmailId}

Request

  • Base URL: https://api.getfinero.com/functions/v1/api
  • URL: https://api.getfinero.com/functions/v1/api/v1/scheduled-emails/{scheduledEmailId}
  • Auth: HTTP bearer

Path parameters

scheduledEmailIdstring uuid required

Scheduled email id.

Response

Success

idstring uuid required

Deleted scheduled email id.

deletedboolean required

True when the schedule was deleted.

Changes

No recorded changes to this operation across all 1 revision of this API.