Scheduler

Reschedule a payment-link email

Changed on

Changes the tenant-local send time of an email whose status is scheduled or failed. A processing email cannot be edited while its provider outcome may be in flight.

Requires an admin API key (has side effects).

patch/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.

Request body

scheduled_localstring required

New tenant-local YYYY-MM-DDTHH:mm send time.

Response

Success

idstring uuid required

Scheduled email id.

payment_link_idstring uuid required

Payment link this email will deliver.

scheduled_forstring date-time required

Resolved send instant (ISO 8601 UTC).

timezonestring required

Tenant timezone snapshot used for scheduling.

status'scheduled' | 'processing' | 'failed' required

Current scheduler state. Successful deliveries leave this active queue.

attempt_countinteger required

Dispatch attempts so far.

next_attempt_atstring date-time nullable required

Next bounded retry instant (ISO 8601 UTC).

last_error_codestring nullable required

Categorical failure code; never a provider response or recipient detail.

created_atstring date-time required

Creation time (ISO 8601 UTC).

updated_atstring date-time required

Last update time (ISO 8601 UTC).

Changes

  • d17186951474Revision changes
    • warning

      added the new link_already_covered enum value to the / response property for the response status

    • warning

      added the new link_already_covered enum value to the / response property for the response status

    • warning

      added the new link_already_covered enum value to the / response property for the response status

    • warning

      added the new link_already_covered enum value to the / response property for the response status

    • warning

      added the new link_already_covered enum value to the / response property for the response status

    • warning

      added the new link_already_covered enum value to the / response property for the response status

    • warning

      added the new link_already_covered enum value to the / response property for the response status

    • warning

      added the new link_already_covered enum value to the / response property for the response status

    • warning

      added the new link_not_withdrawable enum value to the / response property for the response status

    • warning

      added the new link_not_withdrawable enum value to the / response property for the response status

    • warning

      added the new link_not_withdrawable enum value to the / response property for the response status

    • warning

      added the new link_not_withdrawable enum value to the / response property for the response status

    • warning

      added the new link_not_withdrawable enum value to the / response property for the response status

    • warning

      added the new link_not_withdrawable enum value to the / response property for the response status

    • warning

      added the new link_not_withdrawable enum value to the / response property for the response status

    • warning

      added the new link_not_withdrawable enum value to the / response property for the response status