Buttondown logo

Updating a subscriber's automation

This endpoint allows you to update an automation attempt for a specific subscriber. Currently, the only supported action is skipping an automation attempt by setting its status to skipped.

This is useful when you want to prevent a specific automation from being sent to a subscriber without removing them from the automation entirely.

Sample requests

These sample requests are autogenerated by the OpenAPI spec. This endpoint requires one or more parameters in the URL: those are offset in curly-braces.

import requests

url = "https://api.buttondown.com/v1/subscribers/{id_or_email}/automations/{automation_attempt_id}"
headers = {
  "Authorization": "Token $BUTTONDOWN_API_KEY"
}

response = requests.request("PATCH", url, headers=headers)
print(response.text)

Sample responses

The IDs and values referenced in these responses are fake; please only rely on these responses for overall structure.

{
    "actions": [
        {
            "metadata": {
                "email_id": "13121cd6-0dfc-424c-bb12-988b0a32fcb3"
            },
            "type": "send_email"
        }
    ],
    "automation_id": "13121cd6-0dfc-424c-bb12-988b0a32fcb3",
    "execution_date": "2020-09-28T00:00:00+00:00",
    "id": "13121cd6-0dfc-424c-bb12-988b0a32fcb5",
    "name": "Welcome email",
    "status": "failed"
}

Path parameters

Consult the Filtering documentation for more information on how to filter and sort your requests.

status

Type
string · required
Description

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

Body parameters

All parameters are optional unless explicitly specified.

status

Type
string · required
Description

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