Update automation action

PUT /api/v3/automation_actions/{id}

Request

Response

URL

PUT https://example.aha.io/api/v3/automation_actions/123

JSON body

{
  "record": {}
}

cURL command

curl --request PUT 'https://example.aha.io/api/v3/automation_actions/123' \
  --header 'Authorization: Bearer YOUR_API_TOKEN' \
  --header 'Accept: application/json' \
  --header 'Content-Type: application/json' \
  --data-raw '{
  "record": {}
}'

Request conventions

API key or OAuth2 access token. See Authentication.

Use your account domain and token in copied requests. Request values and conditional fields must satisfy your account’s validation rules.

URL settings

Account subdomain

The part before .aha.io. Leave blank to use the example domain.

ID of the automation action

Request fields

Send only the fields you want to change inside a JSON record object. This applies to both PUT and PATCH.

Only writable fields for this endpoint are listed. Required flags reflect the endpoint schema; record and workspace validation also applies.

Search request fields

Field	Type	Response field
Configuration for update_field and update_related_field actions.	object	`field`
Include field in request Accepted value shape and constraints Type: `object` custom_field_definition_id Type: `string` field_worksheet_row Type: `string` action Type: `string` Allowed values: "set", "cleared", "copy", "add", "remove" sub_action Type: `string` Allowed values: "same_day", "next_day", "2_days_after", "3_days_after", "4_days_after", "5_days_after", "1_week_after", "2_weeks_after", "3_weeks_after", "1_month_after", "2_months_after", "3_months_after", "6_months_after", "12_months_after", "flagged", "flagged_with_comment" values Type: `array` Array item shape Type: `string` source Type: `string` Allowed values: "name", "status", "team_status", "type", "initiative", "assigned_to_user", "created_by_user", "epic", "end_date", "start_date", "tags", "goals", "key_results", "release", "watchers", "iteration", "record_risk", "progress", "initiative_name", "initiative_roll_up_initiative", "initiative_status", "initiative_time_frame", "initiative_end_date", "initiative_start_date", "initiative_goals", "initiative_key_results", "initiative_assigned_to_user", "initiative_created_by_user", "initiative_watchers", "initiative_progress", "initiative_record_risk", "release_name", "release_owner", "release_created_by_user", "release_status", "release_release_date", "release_development_started_on", "release_external_release_date", "release_initiatives", "release_goals", "release_key_results", "release_watchers", "release_progress", "epic_name", "epic_status", "epic_team_status", "epic_initiative", "epic_assigned_to_user", "epic_created_by_user", "epic_end_date", "epic_start_date", "epic_tags", "epic_goals", "epic_key_results", "epic_release", "epic_watchers", "epic_iteration", "epic_progress", "epic_record_risk", "owner", "release_date", "development_started_on", "external_release_date", "initiatives", "feature_name", "feature_status", "feature_team_status", "feature_type", "feature_initiative", "feature_assigned_to_user", "feature_created_by_user", "feature_epic", "feature_end_date", "feature_start_date", "feature_tags", "feature_goals", "feature_key_results", "feature_release", "feature_watchers", "feature_iteration", "feature_record_risk", "feature_progress", "categories", "visibility", "roll_up_initiative", "time_frame", "rollup_goals", "target_metric", "starting_metric", "current_metric", "task_status", "due_date", "release_phase_name", "release_phase_start_date", "release_phase_end_date", "release_phase_progress", "release_phase_release", "requirement_name", "requirement_status", "requirement_team_status", "requirement_assigned_to_user", "requirement_created_by_user", "requirement_end_date", "requirement_start_date", "requirement_iteration", "requirement_record_risk", "approval_groups", "assignees", "collections", "current_date", "custom_field" source_custom_field_definition_id Type: `string` source_worksheet_row Type: `string` related_record_type Type: `string` Allowed values: "feature", "release", "release_phase", "epic", "requirement", "idea", "initiative", "goal", "key_result", "task", "approval", "work_request" field Type: `string` Allowed values: "name", "status", "team_status", "type", "initiative", "assigned_to_user", "created_by_user", "epic", "end_date", "start_date", "tags", "goals", "key_results", "score", "release", "watchers", "team", "iteration", "record_risk", "progress", "initial_estimate", "detailed_estimate", "record_links", "custom_field", "owner", "release_date", "development_started_on", "external_release_date", "initiatives", "roll_up_initiative", "time_frame", "rollup_goals", "target_metric", "starting_metric", "current_metric", "duplicate_idea", "categories", "visibility", "num_endorsements", "num_organizations", "submitted_idea_portal", "parent", "collections", "task_status", "due_date", "approval_groups", "assignees"
Configuration for create_comment and create_idea_admin_response actions.	object	`comment`
Include comment in request Accepted value shape and constraints Type: `object` body Type: `string`
Configuration for create_requirement actions.	object	`requirement`
Include requirement in request Accepted value shape and constraints Type: `object` name Type: `string` body Type: `string` assigned_to_user Type: `string` Allowed values: "unassigned", "values", "custom_field", "assigned_to_user", "created_by_user", "owner", "initiative_assigned_to_user", "initiative_created_by_user", "release_owner", "release_created_by_user", "epic_assigned_to_user", "epic_created_by_user", "feature_assigned_to_user", "feature_created_by_user", "requirement_assigned_to_user", "requirement_created_by_user" custom_field_definition_id Type: `string` value Type: `string`
Configuration for create_task actions.	object	`task`
Include task in request Accepted value shape and constraints Type: `object` type Type: `string` Allowed values: "task", "approval", "work_request" name Type: `string` body Type: `string` due_date Type: `string` Allowed values: "same_day", "next_day", "2_days_after", "3_days_after", "4_days_after", "5_days_after", "1_week_after", "2_weeks_after", "3_weeks_after", "1_month_after", "2_months_after", "3_months_after", "6_months_after", "12_months_after" assigned_to_user Type: `string` Allowed values: "unassigned", "values", "custom_field", "assigned_to_user", "created_by_user", "owner", "initiative_assigned_to_user", "initiative_created_by_user", "release_owner", "release_created_by_user", "epic_assigned_to_user", "epic_created_by_user", "feature_assigned_to_user", "feature_created_by_user", "requirement_assigned_to_user", "requirement_created_by_user" custom_field_definition_id CustomFieldDefinition Type: `object` id Type: `integer` name Type: `string` internal_name Type: `string` key Type: `string` type Type: `string` Allowed values: "text", "note", "number", "date", "url", "checkbox", "attachment", "predefined_choice_list", "editable_choice_list", "predefined_tags", "tags", "conditional_choice", "scorecard", "worksheet", "many_to_many_relationship", "many_to_one_relationship", "one_to_many_relationship", "users", "workspaces", "goals", "initiatives", "key_results", "releases", "epics", "features", "ideas", "idea_categories", "organizations", "idea_created_by", "competitors", "personas", "creative_briefs" record_type Type: `string` Allowed values: "project", "feature", "epic", "requirement", "release", "release_phase", "initiative", "goal", "key_result", "idea", "idea_endorsement", "idea_organization", "idea_user", "creative_brief", "persona", "competitor", "capacity_investment", "team", "program_increment", "task", "document", "study", "interview", "custom_table" custom_table CustomObjectDefinition Type: `object` id Type: `integer` name Type: `string` key Type: `string` created_at Type: `string` (date-time) updated_at Type: `string` (date-time) description Note Type: `object` id Type: `integer` body Type: `string` editor_version Type: `integer` created_at Type: `string` (date-time) updated_at Type: `string` (date-time) prefix Type: `string` suffix Type: `string` use_delimiters Type: `boolean` label Type: `string` display Type: `string` Allowed values: "plain_text", "colored_labels" scope Type: `string` Allowed values: "account", "project_line", "project", "related" supported_file_types Type: `array` Array item shape Type: `string` linked_custom_table CustomObjectDefinition Type: `object` id Type: `integer` name Type: `string` key Type: `string` created_at Type: `string` (date-time) updated_at Type: `string` (date-time) project_scope Type: `string` Allowed values: "account", "project" scoring_system ScoringSystem Type: `object` id Type: `integer` name Type: `string` created_at Type: `string` (date-time) updated_at Type: `string` (date-time) values Type: `object` Required properties: records, has_more. records Type: `array` Array item shape AutomationRecordValueConfig Type: `object` id Type: `integer` type Type: `string` url Type: `string` (uri) has_more Type: `boolean` next_url Type: `string` (uri)
Configuration for create_document actions.	object	`document`
Include document in request Accepted value shape and constraints Type: `object` name Type: `string` body Type: `string` note_template_id Type: `string` tag_ids Type: `array` Array item shape Type: `string` inherit_tags Type: `boolean`
Configuration for create_custom_table_record actions.	object	`custom_table_record`
Include custom_table_record in request Accepted value shape and constraints Type: `object` link_custom_field_definition_id Type: `string` custom_table_id Type: `string` fields Type: `array` Array item shape AutomationCustomTableFieldConfig Type: `object` custom_field_definition_id Type: `string` field_worksheet_row Type: `string` action Type: `string` Allowed values: "set", "cleared", "copy", "add", "remove" sub_action Type: `string` Allowed values: "same_day", "next_day", "2_days_after", "3_days_after", "4_days_after", "5_days_after", "1_week_after", "2_weeks_after", "3_weeks_after", "1_month_after", "2_months_after", "3_months_after", "6_months_after", "12_months_after", "flagged", "flagged_with_comment" values Type: `array` Array item shape Type: `string` source Type: `string` Allowed values: "name", "status", "team_status", "type", "initiative", "assigned_to_user", "created_by_user", "epic", "end_date", "start_date", "tags", "goals", "key_results", "release", "watchers", "iteration", "record_risk", "progress", "initiative_name", "initiative_roll_up_initiative", "initiative_status", "initiative_time_frame", "initiative_end_date", "initiative_start_date", "initiative_goals", "initiative_key_results", "initiative_assigned_to_user", "initiative_created_by_user", "initiative_watchers", "initiative_progress", "initiative_record_risk", "release_name", "release_owner", "release_created_by_user", "release_status", "release_release_date", "release_development_started_on", "release_external_release_date", "release_initiatives", "release_goals", "release_key_results", "release_watchers", "release_progress", "epic_name", "epic_status", "epic_team_status", "epic_initiative", "epic_assigned_to_user", "epic_created_by_user", "epic_end_date", "epic_start_date", "epic_tags", "epic_goals", "epic_key_results", "epic_release", "epic_watchers", "epic_iteration", "epic_progress", "epic_record_risk", "owner", "release_date", "development_started_on", "external_release_date", "initiatives", "feature_name", "feature_status", "feature_team_status", "feature_type", "feature_initiative", "feature_assigned_to_user", "feature_created_by_user", "feature_epic", "feature_end_date", "feature_start_date", "feature_tags", "feature_goals", "feature_key_results", "feature_release", "feature_watchers", "feature_iteration", "feature_record_risk", "feature_progress", "categories", "visibility", "roll_up_initiative", "time_frame", "rollup_goals", "target_metric", "starting_metric", "current_metric", "task_status", "due_date", "release_phase_name", "release_phase_start_date", "release_phase_end_date", "release_phase_progress", "release_phase_release", "requirement_name", "requirement_status", "requirement_team_status", "requirement_assigned_to_user", "requirement_created_by_user", "requirement_end_date", "requirement_start_date", "requirement_iteration", "requirement_record_risk", "approval_groups", "assignees", "collections", "current_date", "custom_field" source_custom_field_definition_id Type: `string` source_worksheet_row Type: `string`
Configuration for send_email actions.	object	`email`
Include email in request Accepted value shape and constraints Type: `object` to Type: `string` Allowed values: "values", "custom_field", "assigned_to_user", "created_by_user", "owner", "initiative_assigned_to_user", "initiative_created_by_user", "release_owner", "release_created_by_user", "epic_assigned_to_user", "epic_created_by_user", "feature_assigned_to_user", "feature_created_by_user", "requirement_assigned_to_user", "requirement_created_by_user" custom_field_definition_id CustomFieldDefinition Type: `object` id Type: `integer` name Type: `string` internal_name Type: `string` key Type: `string` type Type: `string` Allowed values: "text", "note", "number", "date", "url", "checkbox", "attachment", "predefined_choice_list", "editable_choice_list", "predefined_tags", "tags", "conditional_choice", "scorecard", "worksheet", "many_to_many_relationship", "many_to_one_relationship", "one_to_many_relationship", "users", "workspaces", "goals", "initiatives", "key_results", "releases", "epics", "features", "ideas", "idea_categories", "organizations", "idea_created_by", "competitors", "personas", "creative_briefs" record_type Type: `string` Allowed values: "project", "feature", "epic", "requirement", "release", "release_phase", "initiative", "goal", "key_result", "idea", "idea_endorsement", "idea_organization", "idea_user", "creative_brief", "persona", "competitor", "capacity_investment", "team", "program_increment", "task", "document", "study", "interview", "custom_table" custom_table CustomObjectDefinition Type: `object` id Type: `integer` name Type: `string` key Type: `string` created_at Type: `string` (date-time) updated_at Type: `string` (date-time) description Note Type: `object` id Type: `integer` body Type: `string` editor_version Type: `integer` created_at Type: `string` (date-time) updated_at Type: `string` (date-time) prefix Type: `string` suffix Type: `string` use_delimiters Type: `boolean` label Type: `string` display Type: `string` Allowed values: "plain_text", "colored_labels" scope Type: `string` Allowed values: "account", "project_line", "project", "related" supported_file_types Type: `array` Array item shape Type: `string` linked_custom_table CustomObjectDefinition Type: `object` id Type: `integer` name Type: `string` key Type: `string` created_at Type: `string` (date-time) updated_at Type: `string` (date-time) project_scope Type: `string` Allowed values: "account", "project" scoring_system ScoringSystem Type: `object` id Type: `integer` name Type: `string` created_at Type: `string` (date-time) updated_at Type: `string` (date-time) values Type: `object` Required properties: records, has_more. records Type: `array` Array item shape AutomationRecordValueConfig Type: `object` id Type: `integer` type Type: `string` url Type: `string` (uri) has_more Type: `boolean` next_url Type: `string` (uri) subject Type: `string` body Type: `string`

Response fields

Choose which fields to include in the response. Expand a field for examples and associated fields. Collections can only be returned on the top-level resource, not inside an associated resource.

Default response fields are returned until you select specific fields.

Search fields

Field	Type	Returned by default
Unique record ID.	integer	Yes
Include id in response
Automation that owns the action.	Automation	No
Include automation in response Expand this association to browse its response fields.
Type of the automation action.	string	No
Include type in response Allowed values: `update_fieldupdate_related_fieldcreate_commentcreate_taskcreate_requirementcreate_documentcreate_custom_table_recordsend_emailsend_to_integrationresend_to_integrationcreate_idea_admin_response`
Date and time when the record was created.	date-time	No
Include created_at in response
Date and time when the record was last updated.	date-time	No
Include updated_at in response
Configuration for update_field and update_related_field actions.	AutomationUpdateFieldConfig	No
Include field in response Expand this association to browse its response fields.
Configuration for create_comment and create_idea_admin_response actions.	AutomationCreateCommentConfig	No
Include comment in response Expand this association to browse its response fields.
Configuration for create_requirement actions.	AutomationCreateRequirementConfig	No
Include requirement in response Expand this association to browse its response fields.
Configuration for create_task actions.	AutomationCreateTaskConfig	No
Include task in response Expand this association to browse its response fields.
Configuration for create_document actions.	AutomationCreateDocumentConfig	No
Include document in response Expand this association to browse its response fields.
Configuration for create_custom_table_record actions.	AutomationCreateCustomTableRecordConfig	No
Include custom_table_record in response Expand this association to browse its response fields.
Configuration for send_email actions.	AutomationSendEmailConfig	No
Include email in response Expand this association to browse its response fields.
Configuration for send_to_integration actions.	AutomationSendToIntegrationConfig	No
Include integration_mapping in response Expand this association to browse its response fields.

Search matches the start of a field path and includes matching associations’ subfields. Use a dotted path to search within a specific association.

Response field selection

Create and update responses also include fields submitted in the record body. Submitted association IDs return their associated response fields.

Return selected fields with a comma-separated fields parameter, or add a field to the defaults with fields=default,{field}. Expand an association above for its supported subfields and selection examples.

See field selection for details.

Response statuses

Error shape for 400, 401, 403, 404, 409

Type: object

error

Type: object

Required properties: status, code, message, request_id.

status

Type: integer

code

Type: string

message

Type: string

request_id

Type: string

Error shape for 422

Type: object

error

Type: object

Required properties: status, code, message, details, request_id.

status

Type: integer

Allowed values: 422

code

Type: string

Allowed values: "record.validation_failed", "record.cannot_delete"

message

Type: string

details

Type: array

Array item shape

Type: object

field

Type: string

message

Type: string

code

Type: string

request_id

Type: string

Response envelope and pagination

record: a single record. Fields are documented above.

Download the complete OpenAPI specification