Automations

Pause an automation rule

Stop an active automation rule from firing, keeping its definition and run history.

  • Returns 200 with the rule in its new state; seals no new version, and it can be activated again.
  • Only an active rule can be paused; anything else returns 422.
post/companies/{company}/automations/rules/{rule}/pause

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/automations/rules/{rule}/pause
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

rulestring uuid required

Public identifier (UUID v7) of the automation rule.

Headers

Idempotency-Keystring
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide.

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Response

Example response

{
  "data": {
    "id": "01931b3e-7c4a-7f2e-9a8b-3c5d6e7f8a61",
    "name": "Avisar de un cobro grande",
    "description": "Notifica a los administradores cuando se cobra una factura de 1000 EUR o más.",
    "trigger_type": "invoice.paid",
    "scope": "empresa",
    "conditions": {
      "field": "total",
      "operator": "gte",
      "value": 1000
    },
    "actions": [
      {
        "type": "notify_in_app",
        "order": 0,
        "parameters": {
          "recipient_type": "role",
          "role": "admin",
          "category": "invoice",
          "title": "Cobro grande",
          "message": "Se ha cobrado una factura de 1000 EUR o más."
        }
      }
    ],
    "status": "active",
    "current_version": 2,
    "created_at": "2026-03-15T10:00:00Z",
    "updated_at": "2026-03-16T09:30:00Z"
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.