Update action

> ## Documentation Index
> Fetch the complete documentation index at: https://docs.usefini.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Update action

> Update an action, including its input and output schema.

Updates one [`Action`](/en/api-reference/actions-and-attributes#action-or-attribute-object). This is where you set the `inputSchema` and `outputSchema`.

<Warning>
  An action returns nothing to a rule unless it declares an `outputSchema`. For fields sourced from an external API call, set `source: "apiResponse"` and map each output field with `path: "[stepId].[responseMappingKey]"`.
</Warning>

## Headers

<ParamField header="Authorization" type="string" required>
  Bearer token containing your Fini workspace API key. Format: `Bearer fini_...` The key needs `write` scope.
</ParamField>

<ParamField header="Content-Type" type="string" required>
  `application/json`
</ParamField>

## Path parameters

<ParamField path="id" type="string" required>
  Action ID to update.
</ParamField>

## Body parameters

All fields are optional. Send only what you want to change.

<ParamField body="name" type="string">
  Updated display name.
</ParamField>

<ParamField body="description" type="string">
  Updated description.
</ParamField>

<ParamField body="alwaysGet" type="boolean">
  Send `true` to convert the action into an attribute.
</ParamField>

<ParamField body="inputSchema" type="InputSchemaField[]">
  Typed inputs. See [InputSchemaField](/en/api-reference/actions-and-attributes#inputschemafield-object).
</ParamField>

<ParamField body="outputSchema" type="OutputSchemaField[]">
  Typed outputs. See [OutputSchemaField](/en/api-reference/actions-and-attributes#outputschemafield-object).
</ParamField>

## Response

Returns the updated [`Action / Attribute`](/en/api-reference/actions-and-attributes#action-or-attribute-object).

<RequestExample>
  ~~~bash cURL theme={null}
  curl --request PATCH \
    --url 'https://api-prod.usefini.com/v2/hc-tools/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/public' \
    --header 'Authorization: Bearer fini_your_api_key' \
    --header 'Content-Type: application/json' \
    --data '{
    "name": "Refund policy",
    "description": "Refund-policy conversations to re-check before prompt changes.",
    "alwaysGet": false,
    "inputSchema": [
      "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
    ],
    "outputSchema": [
      "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
    ]
  }'
  ~~~

  ~~~javascript Node.js theme={null}
  const response = await fetch('https://api-prod.usefini.com/v2/hc-tools/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/public', {
    method: 'PATCH',
    headers: {
      Authorization: 'Bearer fini_your_api_key',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
    'name': 'Refund policy',
    'description': 'Refund-policy conversations to re-check before prompt changes.',
    'alwaysGet': false,
    'inputSchema': [
      '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3'
    ],
    'outputSchema': [
      '4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3'
    ]
  }
    )
  });

  const data = await response.json();
  ~~~

  ~~~python Python theme={null}
  import requests

  response = requests.patch(
      "https://api-prod.usefini.com/v2/hc-tools/4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3/public",
      headers={"Authorization": "Bearer fini_your_api_key", "Content-Type": "application/json"},
      json={
      "name": "Refund policy",
      "description": "Refund-policy conversations to re-check before prompt changes.",
      "alwaysGet": False,
      "inputSchema": [
          "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
      ],
      "outputSchema": [
          "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3"
      ]
  },
  )

  data = response.json()
  ~~~
</RequestExample>

<ResponseExample>
  ~~~json 200 OK theme={null}
  {
    "id": "4f5ef695-d03b-4d56-8fef-7f2bd5c17ef3",
    "name": "Cancel subscription",
    "description": "Cancel an active subscription in billing.",
    "inputFields": [
      {
        "name": "customerId",
        "type": "string",
        "required": true
      }
    ],
    "outputFields": [
      {
        "name": "confirmationId",
        "type": "string"
      },
      {
        "name": "effectiveDate",
        "type": "string"
      }
    ],
    "createdAt": "2026-07-28T08:55:32.000Z",
    "updatedAt": "2026-07-28T09:10:18.000Z"
  }
  ~~~
</ResponseExample>

## Errors

<AccordionGroup>
  <Accordion title="400 Bad Request" icon="circle-exclamation">
    The body is malformed.
  </Accordion>

  <Accordion title="401 Unauthorized" icon="lock">
    The API key is missing, malformed, revoked, or invalid.
  </Accordion>

  <Accordion title="403 Forbidden" icon="shield-halved">
    The API key does not include the `write` scope required for this route.
  </Accordion>

  <Accordion title="404 Not Found" icon="ghost">
    No action with that ID exists in your workspace.
  </Accordion>

  <Accordion title="500 Internal Server Error" icon="triangle-exclamation">
    Fini failed while updating the record in storage.
  </Accordion>
</AccordionGroup>


## Related topics

- [Create action](/en/api-reference/create-action.md)
- [API overview](/en/api-reference/overview.md)
- [Overview](/en/api-reference/actions-and-attributes.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.