Skip to main content
PATCH
/
api
/
pulses
cURL
curl --request PATCH \
  --url https://recoup-api.vercel.app/api/pulses \
  --header 'Content-Type: application/json' \
  --data '
{
  "active": true,
  "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}
'
{
  "status": "success",
  "pulses": [
    {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "account_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "active": true
    }
  ],
  "error": "<string>"
}

Body

application/json

Pulse fields to update

​
active
boolean
required

Whether to enable or disable the pulse

Example:

true

​
account_id
string<uuid>

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.

Response

Pulse updated successfully

​
status
enum<string>
required

Status of the request

Available options:
success,
error
​
pulses
object[]
required

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

​
error
string

Error message (only present if status is error)