Update Saved Filter

Update an existing saved report filter

PATCH /v2/reporting/saved/{id}

Update Saved Filter

cURL

curl --request PATCH \
  --url https://api.voxo.co/v2/reporting/saved/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenantId": 1,
  "queryParams": {},
  "postParams": {},
  "name": "<string>",
  "description": "<string>",
  "scheduled": 0,
  "recipients": "<string>",
  "frequency": "daily"
}
'

200

{
  "id": 123,
  "userId": 123,
  "tenantId": 123,
  "apiUrl": "<string>",
  "module": "<string>",
  "createdAt": "<string>",
  "deletedAt": "<string>",
  "name": "<string>",
  "description": "<string>",
  "scheduled": 123,
  "recipients": "<string>",
  "frequency": "<string>",
  "error": 123,
  "errorDescription": "<string>",
  "queryParams": "<unknown>",
  "postParams": "<unknown>"
}

Authorizations

Authorization · string · header · required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

id · number · required

Saved filter ID

Required range: x > 0

Body

application/json

tenantId · number

Tenant ID

Required range: x > 0

queryParams · object

Query parameters for the filter

Show child attributes

postParams · object

POST body parameters for the filter

Show child attributes

name · string

Name of the saved filter

description · string

Description of the saved filter

scheduled · Option 1 · enum<number> Option 2 · enum<number> · default: 0

Whether this filter is scheduled (0 = no, 1 = yes)

Available options: 0

recipients · string

Comma-separated email recipients for scheduled reports

frequency · Option 1 · enum<string> Option 2 · enum<string> Option 3 · enum<string>

Schedule frequency (daily, weekly, or monthly)

Available options: daily

Response

200

application/json

Updated saved filter

id · number · required

Saved filter ID

userId · number · required

User ID who created the filter

tenantId · number · required

Tenant ID

apiUrl · string · required

API URL for the filter

module · string · required

Reporting module

createdAt · string · required

Creation timestamp

deletedAt · string | null · required

Deletion timestamp

name · string · required

Filter name

description · string | null · required

Filter description

scheduled · number · required

Whether scheduled (0 or 1)

recipients · string | null · required

Email recipients

frequency · string | null · required

Schedule frequency

error · number · required

Error flag (0 or 1)

errorDescription · string | null · required

Error description

queryParams · any | null

Query parameters

postParams · any | null

POST body parameters