Skip to main content
PATCH
/
api
/
pulses
cURL
curl --request PATCH \
  --url https://recoup-api.vercel.app/api/pulses \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --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>"
}

Authorizations

​
x-api-key
string
header
required

Your Recoup API key. Learn more.

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 for organization API keys - org keys can specify an account_id for any account within their organization. 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. For personal keys, contains one pulse. For org keys, contains pulses for all accounts in the organization.

​
error
string

Error message (only present if status is error)