Update action destination
Updates a destination’s config, subscriptions, or status.
PATCH
/
v1
/
actions
/
destinations
/
{destination_id}
import olira
olira.init(api_key="YOUR_API_KEY")
destination = olira.update_action_destination(
destination_id="68582e4a0a0b3c1234567890",
subscribed_triggers=["patient.state.changed", "ingestion.failed"],
)
print(destination.subscribed_triggers)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var destination = OliraModule.UpdateActionDestination(
destinationId: "68582e4a0a0b3c1234567890",
subscribedTriggers: ["patient.state.changed", "ingestion.failed"]);
Console.WriteLine(destination.SubscribedTriggers);
PATCH /v1/actions/destinations/68582e4a0a0b3c1234567890
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"subscribed_event_types": ["patient.state.changed", "ingestion.failed"]
}
ActionDestination(
id="68582e4a0a0b3c1234567890",
subscribed_triggers=["patient.state.changed", "ingestion.failed"],
status="active",
)
{
"error": true,
"status_code": 401,
"error_type": "authentication_error",
"message": "Could not validate credentials",
"details": [
{
"type": "authentication_error",
"message": "Could not validate credentials"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 403,
"error_type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint",
"details": [
{
"type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 404,
"error_type": "not_found_error",
"message": "Destination not found",
"details": [
{
"type": "not_found_error",
"message": "Destination not found"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 422,
"error_type": "validation_error",
"message": "Request validation failed (1 error)",
"details": [
{
"type": "value_error",
"message": "Request validation failed"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 429,
"error_type": "server_error",
"message": "Rate limit exceeded",
"details": [
{
"type": "rate_limit",
"message": "Too many requests; retry after backoff"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 500,
"error_type": "internal_server_error",
"message": "An internal server error occurred",
"details": [
{
"type": "internal_server_error",
"message": "An unexpected error occurred while processing your request"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
olira.update_action_destination(
destination_id: str,
url: str | None = None,
to_email: str | None = None,
subject: str | None = None,
description: str | None = None,
subscribed_triggers: list[ActionTrigger | str] | None = None,
status: str | None = None,
static_headers: dict[str, str] | None = None,
digest_schedule: DigestSchedule | None = None,
clear_digest_schedule: bool = False,
) -> ActionDestination
OliraModule.UpdateActionDestination(
string destinationId,
string? url = null,
string? toEmail = null,
string? subject = null,
string? description = null,
IReadOnlyList<string>? subscribedTriggers = null,
string? status = null,
IReadOnlyDictionary<string, string>? staticHeaders = null,
DigestSchedule? digestSchedule = null,
bool clearDigestSchedule = false,
) // -> ActionDestination
sdk:actions
Only the fields you pass are changed. Turning digest batching off needs its own flag (clear_digest_schedule) since omitting digest_schedule means “leave it as-is,” not “remove it” — passing both raises ValueError.
Parameters
str
required
The destination’s id.
str | None
New URL (webhook destinations only).
str | None
New recipient (email destinations only).
str | None
New subject (email destinations only).
str | None
New description.
list[ActionTrigger | str] | None
Replaces the full subscription list.
str | None
“active” or “disabled”. Re-enabling clears the failure streak.
dict[str, str] | None
Replaces the stored static headers.
DigestSchedule | None
New digest schedule.
bool
default:"False"
Pass True to turn digest batching off. Mutually exclusive with digest_schedule.
Returns
ActionDestination
str
Destination id.
list[str]
Updated trigger subscriptions.
str
Updated status.
Raises
| Exception | When |
|---|---|
AuthError | HTTP 401 or 403 — invalid API key or insufficient OAuth scope for this endpoint. |
ValidationError | HTTP 400, 404, or 422 — malformed JSON or validation failure (message includes response excerpt). |
ServerError | HTTP 409 (e.g. conflicting external identifier) or repeated 5xx after retries; includes status_code when applicable. |
RateLimitError | HTTP 429 — rate limited; check retry_after (seconds). |
NetworkError | Connection timeout, DNS failure, or read error after retries. |
import olira
olira.init(api_key="YOUR_API_KEY")
destination = olira.update_action_destination(
destination_id="68582e4a0a0b3c1234567890",
subscribed_triggers=["patient.state.changed", "ingestion.failed"],
)
print(destination.subscribed_triggers)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var destination = OliraModule.UpdateActionDestination(
destinationId: "68582e4a0a0b3c1234567890",
subscribedTriggers: ["patient.state.changed", "ingestion.failed"]);
Console.WriteLine(destination.SubscribedTriggers);
PATCH /v1/actions/destinations/68582e4a0a0b3c1234567890
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"subscribed_event_types": ["patient.state.changed", "ingestion.failed"]
}
ActionDestination(
id="68582e4a0a0b3c1234567890",
subscribed_triggers=["patient.state.changed", "ingestion.failed"],
status="active",
)
{
"error": true,
"status_code": 401,
"error_type": "authentication_error",
"message": "Could not validate credentials",
"details": [
{
"type": "authentication_error",
"message": "Could not validate credentials"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 403,
"error_type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint",
"details": [
{
"type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 404,
"error_type": "not_found_error",
"message": "Destination not found",
"details": [
{
"type": "not_found_error",
"message": "Destination not found"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 422,
"error_type": "validation_error",
"message": "Request validation failed (1 error)",
"details": [
{
"type": "value_error",
"message": "Request validation failed"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 429,
"error_type": "server_error",
"message": "Rate limit exceeded",
"details": [
{
"type": "rate_limit",
"message": "Too many requests; retry after backoff"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 500,
"error_type": "internal_server_error",
"message": "An internal server error occurred",
"details": [
{
"type": "internal_server_error",
"message": "An unexpected error occurred while processing your request"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
⌘I
import olira
olira.init(api_key="YOUR_API_KEY")
destination = olira.update_action_destination(
destination_id="68582e4a0a0b3c1234567890",
subscribed_triggers=["patient.state.changed", "ingestion.failed"],
)
print(destination.subscribed_triggers)
using Olira;
OliraModule.Init(apiKey: "YOUR_API_KEY");
var destination = OliraModule.UpdateActionDestination(
destinationId: "68582e4a0a0b3c1234567890",
subscribedTriggers: ["patient.state.changed", "ingestion.failed"]);
Console.WriteLine(destination.SubscribedTriggers);
PATCH /v1/actions/destinations/68582e4a0a0b3c1234567890
Authorization: Bearer YOUR_API_KEY
Content-Type: application/json
{
"subscribed_event_types": ["patient.state.changed", "ingestion.failed"]
}
ActionDestination(
id="68582e4a0a0b3c1234567890",
subscribed_triggers=["patient.state.changed", "ingestion.failed"],
status="active",
)
{
"error": true,
"status_code": 401,
"error_type": "authentication_error",
"message": "Could not validate credentials",
"details": [
{
"type": "authentication_error",
"message": "Could not validate credentials"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 403,
"error_type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint",
"details": [
{
"type": "authorization_error",
"message": "Insufficient OAuth scope for this endpoint"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 404,
"error_type": "not_found_error",
"message": "Destination not found",
"details": [
{
"type": "not_found_error",
"message": "Destination not found"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 422,
"error_type": "validation_error",
"message": "Request validation failed (1 error)",
"details": [
{
"type": "value_error",
"message": "Request validation failed"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 429,
"error_type": "server_error",
"message": "Rate limit exceeded",
"details": [
{
"type": "rate_limit",
"message": "Too many requests; retry after backoff"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}
{
"error": true,
"status_code": 500,
"error_type": "internal_server_error",
"message": "An internal server error occurred",
"details": [
{
"type": "internal_server_error",
"message": "An unexpected error occurred while processing your request"
}
],
"timestamp": "2026-05-06T12:00:00+00:00"
}