/v1/issuer/automations/{id}
API Key
Update an automation
Update automation properties. Only provided fields are updated.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
id
*
|
path | string | Automation ID |
X-API-Key
*
|
header | string | Issuer API key for authentication |
* Required parameter
Request Body
Parameters for updating an automation
name
string
Display name for the automation
Example: Updated Employee Badge Automation
trigger_mode
string
How the automation is triggered
Allowed values: "manual", "scheduled", "webhook"
Example: scheduled
schedule
string
Cron expression for scheduled mode
Example: 0 0 * * *
status
string
Automation status
Allowed values: "draft", "active", "paused"
Example: active
Response
Content-Type: application/json
success
boolean
data
object
An automated credential issuance policy
id
*
string
Unique identifier (hashid)
Example: abc123xyz
name
*
string
Display name for the automation
Example: Daily Badge Sync
trigger_mode
*
string
How the automation is triggered: - manual: Triggered via API or dashboard - scheduled: Runs on cron schedule - webhook: Triggered via authenticated webhook
Allowed values: "manual", "scheduled", "webhook"
Example: scheduled
status
*
string
Current status: - draft: Not yet activated - active: Ready to run - paused: Temporarily disabled - error: Error state
Allowed values: "draft", "active", "paused", "error"
Example: active
schedule
string
nullable
Cron expression for scheduled mode
Example: 0 0 * * *
data_source_mapping
*
object
The linked data source mapping
id
*
string
Example: badge-credential-mapping
name
*
string
Example: Employee Database → Employee Badge
account_domain
*
object
The domain under which credentials are issued
id
*
string
Example: aEdOjwxyMwQBkxwgZjNG
domain
*
string
Example: acme-corp.com
can_run
*
boolean
Whether the automation can be triggered
Example: true
running
*
boolean
Whether the automation is currently running
last_run
object
nullable
Information about the last run (detail view only)
at
string (date-time)
Example: 2025-01-15T00:00:00Z
record_count
integer
nullable
Example: 150
error
string
nullable
webhook
object
nullable
Webhook configuration (webhook mode only, detail view)
configured
boolean
Whether a webhook token is configured
Example: true
enabled
boolean
Whether webhook triggers are allowed
Example: true
created_at
*
string (date-time)
When the automation was created
Example: 2025-01-01T00:00:00Z
updated_at
*
string (date-time)
When the automation was last updated
Example: 2025-01-15T10:30:00Z
Code Examples
import os
from aho_sdk import AhoSdk
client = AhoSdk.issuer(api_key=os.environ["AHO_API_KEY"])
result = client.automations.update(
id="example_id",
body={
"name": "Updated Employee Badge Automation",
"trigger_mode": "scheduled",
"schedule": "0 0 * * *",
"status": "active"
}
)client = AhoSdk.issuer(api_key: ENV["AHO_API_KEY"])
result = client.automations.update(
id: "example_id",
body: {
name: "Updated Employee Badge Automation",
trigger_mode: "scheduled",
schedule: "0 0 * * *",
status: "active"
}
)import { AhoSdk } from '@aho/sdk';
const client = AhoSdk.issuer({ apiKey: process.env.AHO_API_KEY });
const result = await client.automations.update({
id: "example_id",
body: {
name: "Updated Employee Badge Automation",
triggerMode: "scheduled",
schedule: "0 0 * * *",
status: "active"
}
});curl -X PATCH 'https://api.aho.com/v1/issuer/automations/example_id' \
-H 'X-API-Key: $AHO_API_KEY' \
-H 'Content-Type: application/json' \
-d '{
"name": "Updated Employee Badge Automation",
"trigger_mode": "scheduled",
"schedule": "0 0 * * *",
"status": "active"
}'Try It
Log in to test this endpoint directly from the documentation.
Log in