BUbuttondown
Subscribers

Update Automation Attempt

Changed on

Update the status of an automation attempt for a subscriber

patch/subscribers/{id_or_email}/automations/{automation_attempt_id}

Request

  • Base URL
    https://api.buttondown.com/v1
  • URL
    https://api.buttondown.com/v1/subscribers/{id_or_email}/automations/{automation_attempt_id}
  • Auth
    API key in header Authorization

Path parameters

id_or_emailstring required
automation_attempt_idstring required

Request body

status'skipped' required

The status to set for the automation attempt. Only 'skipped' is allowed.

Response

OK

idstring required

The ID of this automation attempt.

namestring required

The name of the automation that was triggered.

status'unprocessed' | 'processed' | 'failed' | 'pending' | 'skipped' required

An enumeration.

automation_idstring required

The ID of the automation that was triggered.

execution_datestring date-time required

When the automation attempt is scheduled to execute (or executed).

actionsobject[] required

The resolved actions the automation will take for this subscriber.

error'action_malformed' | 'action_malformed__missing_recipient' | 'action_malformed__missing_tag_ids' | 'action_malformed__missing_url' | 'action_malformed__unsupported_action_type' | 'EMAIL_ALREADY_SENT' | 'EMAIL_DOES_NOT_EXIST' | 'EMAIL_EMPTY' | 'EMAIL_INVALID_STATUS' | 'event_malformed' | 'ID_DOES_NOT_EXIST' | 'INVALID_SUBSCRIBER' | 'arena.misconfigured' | 'bluesky.misconfigured' | 'misconfigured__discord' | 'misconfigured__github' | 'misconfigured__linkedin' | 'mastodon.misconfigured' | 'misconfigured__shopify' | 'tumblr.misconfigured' | 'twitter.misconfigured' | 'NEWSLETTER_DISABLED' | 'not_found' | 'rate_limit' | 'unauthorized' | 'stripe_subscription_does_not_exist' | 'SUBSCRIBER_INVALID' | 'TAG_ALREADY_EXISTS' | 'unexpected_error'

Error codes for skipped or failed automation attempts.

Changes