API REFERENCE

Update Pulse

On this page

PATCH/api/pulses

Update the pulse settings for an account. Use this to enable or disable the pulse. Returns an array of pulses for consistency with the GET endpoint.

Authentication

See the authentication guide for API key and account access requirements.

Request

cURL

curl --request PATCH \
  --url 'https://api.recoupable.dev/api/pulses' \
  --header 'x-api-key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "active": true
}'

Request body required

Pulse fields to update

application/json

activebooleanrequired

Whether to enable or disable the pulse

account_idstring

UUID of the account to update the pulse for. Only applicable when the authenticated account has access to multiple accounts via organization membership. If not provided, updates the pulse for the API key's own account.

format: uuid

Responses

200Pulse updated successfully

application/json

statusstring · enumrequired

Status of the request

Values: "success", "error"

pulsesarray<Pulse>required

Array of pulse objects. Contains pulses for the authenticated account. If the account has access to organizations, all organization accounts are included.

Item properties

idstring

Unique identifier for the pulse

format: uuid

account_idstring

Unique identifier for the associated account

format: uuid

activeboolean

Whether the pulse is active (defaults to true)

errorstring

Error message (only present if status is error)

400Bad request

application/json

errorintegerrequired

format: int32

messagestringrequired

401Unauthorized - invalid or missing API key

application/json

errorintegerrequired

format: int32

messagestringrequired

Full specification

Download the OpenAPI file for complete schemas, constraints, and examples.

Download accounts.json

View operation source

json

{
  "description": "Update the pulse settings for an account. Use this to enable or disable the pulse. Returns an array of pulses for consistency with the GET endpoint.",
  "requestBody": {
    "description": "Pulse fields to update",
    "required": true,
    "content": {
      "application/json": {
        "schema": {
          "$ref": "#/components/schemas/UpdatePulseRequest"
        }
      }
    }
  },
  "responses": {
    "200": {
      "description": "Pulse updated successfully",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/PulsesResponse"
          }
        }
      }
    },
    "400": {
      "description": "Bad request",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    },
    "401": {
      "description": "Unauthorized - invalid or missing API key",
      "content": {
        "application/json": {
          "schema": {
            "$ref": "#/components/schemas/Error"
          }
        }
      }
    }
  }
}