---
title: "Update Automation"
method: PATCH
path: "/api/v3/automations/{automation_id}"
tags: ["Automations"]
---

# Update Automation

`PATCH /api/v3/automations/{automation_id}`

## Path parameters

- `automation_id` string, required

## Request body

- AutomationUpdates
  - `name` string, nullable
  - `status` 'active' | 'archived' | 'deleted'
  - `config` union
    - RankedInstitutionsConfig
      - `version` string, required
      - `filters` RankedInstitutionsFilters, required
        - `signal_setting_ids` string[]
        - `data_sources` SignalSourceType[]
      - `ranking` RankedRanking, required
        - `ng_score` number
        - `population` number
        - `recency` number
        - `signal_count` number
    - VendorContractEnrichmentConfig
      - `version` string, required
      - `filters` UserProfileInstitutionFilter[], required
        - `id` string, uuid, nullable
        - `visibility` 'private' | 'organization'
        - `type` 'institution_type' | 'institution_list', required
        - `payload` union, required
          - InstitutionTypePayload
            - `name` string, nullable
            - `institution_type` string, nullable
            - `account_types` string[], nullable
            - `states` string[], nullable
            - `counties` string[], nullable
            - `cities` string[], nullable
            - `population_min` integer, nullable
            - `population_max` integer, nullable
            - `search_query` string, nullable
          - InstitutionListPayload
            - `institution_ids` string[]
            - `name` string, required
            - `original_filename` string, nullable
            - `original_filter` InstitutionTypePayload
              - …
      - `vendors` VendorWithProducts[], required
        - `name` string, required
        - `products` string[], required
      - `start_date` string, nullable
      - `end_date` string, nullable
      - `workspace_id` string, nullable
    - OutreachSequenceConfig
      - `version` string, required
      - `filters` OutreachSequenceFilters, required
        - `territories` UserProfileInstitutionFilter[]
          - `id` string, uuid, nullable
          - `visibility` 'private' | 'organization'
          - `type` 'institution_type' | 'institution_list', required
          - `payload` union, required
            - InstitutionTypePayload
              - …
            - InstitutionListPayload
              - …
        - `signal_setting_ids` string[]
        - `data_sources` SignalSourceType[]
        - `signal_start_date` string, nullable
        - `signal_end_date` string, nullable
      - `contact_titles_include` string[]
      - `contact_titles_exclude` string[]
      - `email_sequence_id` string, required
    - DeepResearchConfig
      - `version` string, required
      - `filters` UserProfileInstitutionFilter[], required
        - `id` string, uuid, nullable
        - `visibility` 'private' | 'organization'
        - `type` 'institution_type' | 'institution_list', required
        - `payload` union, required
          - InstitutionTypePayload
            - `name` string, nullable
            - `institution_type` string, nullable
            - `account_types` string[], nullable
            - `states` string[], nullable
            - `counties` string[], nullable
            - `cities` string[], nullable
            - `population_min` integer, nullable
            - `population_max` integer, nullable
            - `search_query` string, nullable
          - InstitutionListPayload
            - `institution_ids` string[]
            - `name` string, required
            - `original_filename` string, nullable
            - `original_filter` InstitutionTypePayload
              - …
      - `queries` DeepResearchQuery[], required
        - `id` string
        - `query` string, required
        - `output_type` string, required
        - `column_name` string, required
        - `options` object, nullable
      - `context` string, nullable
    - ContactsExportConfig
      - `version` string, required
      - `filters` UserProfileInstitutionFilter[], required
        - `id` string, uuid, nullable
        - `visibility` 'private' | 'organization'
        - `type` 'institution_type' | 'institution_list', required
        - `payload` union, required
          - InstitutionTypePayload
            - `name` string, nullable
            - `institution_type` string, nullable
            - `account_types` string[], nullable
            - `states` string[], nullable
            - `counties` string[], nullable
            - `cities` string[], nullable
            - `population_min` integer, nullable
            - `population_max` integer, nullable
            - `search_query` string, nullable
          - InstitutionListPayload
            - `institution_ids` string[]
            - `name` string, required
            - `original_filename` string, nullable
            - `original_filter` InstitutionTypePayload
              - …
      - `role_types` string[]
      - `exclude_titles` string[]
      - `hard_match` boolean

## Response `200`

Successful Response

- AutomationResponse
  - `id` string, uuid, required
  - `name` string, required
  - `type` 'ranked_institutions' | 'vendor_contract_enrichment' | 'outreach_sequence' | 'deep_research' | 'contacts_export', required
  - `status` 'active' | 'archived' | 'deleted', required
  - `config` object, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required

## Other responses

- `422` — Validation Error

---

[API](https://skmtc.net/nationgraph/apis/nationgraph-api.md) · [All operations](https://skmtc.net/nationgraph/apis/nationgraph-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/nationgraph/nationgraph-api/versions/85804e68d86d/schema)