Skip to main content
PUT
Update automation

Authorizations

Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id
string
required

The unique identifier of the automation to update.

Body

application/vnd.mailcare.v1+json
title
string
required

Title of the automation

Example:

"Save pdf invoices"

sender
string<email>

Sender that should match (optional)

Example:

"shop@example.com"

inbox
string<email>

Inbox that should match (optional)

Example:

"claire@example.com"

subject
string

Subject that should match (optional)

Example:

"New invoice"

has_attachments
boolean

Email should have at least one attachment (optional)

Example:

true

action_url
string<uri>

URL that will be called (optional)

Example:

"https://example.com/webhooks/save-pdf-invoices"

action_secret_token
string

Use this token to validate received payloads (optional)

Example:

"SECRET12345$"

notification_email
string<email> | null

Email address to notify on webhook failures (optional). If empty, no notification is sent. At most one notification is sent per automation per UTC day.

Example:

"ops@example.com"

action_delete_email
boolean

Email should be deleted after processing (optional)

Example:

true

disabled
boolean

Disable this automation without deleting it (optional)

Example:

false

payload_format
enum<string>

Payload format to use (optional)

Available options:
json,
raw,
json_with_bodies
Example:

"json"

Response

Automation successfully updated.