Automations

Update an automation

Change the name, definition, or status. Definition changes create and atomically activate a new immutable version.

patch/automations/{id}

Request

  • Base URL: https://shipmail.to/api/v1
  • URL: https://shipmail.to/api/v1/automations/{id}
  • Auth: one of:
    • HTTP bearer
    • OAuth 2 (authorization code, authorization URL https://shipmail.to/api/auth/oauth2/authorize, token URL https://shipmail.to/api/auth/oauth2/token)

Headers

X-Shipmail-Organizationstring

OAuth access tokens only. The organization ID this request acts on. Required when the OAuth connection was approved for several organizations (400 validation_error without it); optional with one. An organization the connection was not approved for returns 403 authorization_error. Ignored for API keys, which belong to one organization.

Request body

namestring
status'active' | 'paused' | 'disabled'

Response

Updated automation.

object'automation' required
idstring required
namestring required
status'active' | 'paused' | 'disabled' required
version_idstring required
versioninteger required
next_run_atstring date-time nullable required
created_atstring date-time required
updated_atstring date-time required

Changes

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