Update Monitor

PATCH /v1/monitors/{id}

Free (0 credits) Permission: monitors:write

Updates monitor settings. Changing the webhook URL clears any webhook_failing status.

Authorization

bearerAuth: optional HTTP

apiKeyAuth: optional API key in header

Path parameters

id: required string

Request body JSON required

name: optional string
keywords: optional array ofstring
exclude: optional array ofstring
subreddits: optional array ofstring
posts: optional boolean
comments: optional boolean
nsfw: optional boolean
webhook_url: optional string | null
webhook_kind: optional generic|slack|discord|telegram|null

Returns

200

Updated monitor

JSON

monitor: optional object
- id: required string
- name: required string
- keywords: required array ofstring
- include_posts: required boolean
- include_comments: required boolean
- nsfw: required boolean
- status: required active|paused|paused_balance|deleted
- next_charge_at: required string
  
  format: date-time
- created_at: required string
  
  format: date-time
- updated_at: required string
  
  format: date-time
- exclude: optional array ofstring
- subreddits: optional array ofstring
- webhook_url: optional string | null
- webhook_kind: optional generic|slack|discord|telegram|null
- webhook_failing: optional boolean
- last_match_at: optional string | null
  
  format: date-time

400

Bad request (invalid parameter or unknown action)

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

401

Missing or invalid API key or OAuth access token

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

404

Requested user or resource not found

JSON

One of the following:

ErrorResponse
- error: required string
  
  Human-readable error message
- error_code: optional forbidden_scope|rate_limited|daily_quota_exceeded|insufficient_credits|duplicate_transaction
  
  Machine-readable error code. Known values include: forbidden_scope, rate_limited, daily_quota_exceeded, insufficient_credits, duplicate_transaction. Additional codes may be introduced in future releases.
Error
- error: required object
  
  code: required string
  
  message: required string
  
  retryable: required boolean
  
  retry_after: optional integer
  
  Seconds to wait before retrying.

Update Monitor

curl --request PATCH \
  --url 'https://api.threadapi.dev/v1/monitors/<id>' \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "string",
  "keywords": [
    "string"
  ],
  "exclude": [
    "string"
  ],
  "subreddits": [
    "string"
  ],
  "posts": true,
  "comments": true,
  "nsfw": true,
  "webhook_url": "string",
  "webhook_kind": "generic"
}
'

const url = 'https://api.threadapi.dev/v1/monitors/<id>';
const options = {
  method: 'PATCH',
  headers: {'Content-Type': 'application/json', Authorization: 'Bearer <token>'},
  body: JSON.stringify({
    name: 'string',
    keywords: ['string'],
    exclude: ['string'],
    subreddits: ['string'],
    posts: true,
    comments: true,
    nsfw: true,
    webhook_url: 'string',
    webhook_kind: 'generic'
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.threadapi.dev/v1/monitors/<id>"

payload = {
    "name": "string",
    "keywords": ["string"],
    "exclude": ["string"],
    "subreddits": ["string"],
    "posts": True,
    "comments": True,
    "nsfw": True,
    "webhook_url": "string",
    "webhook_kind": "generic"
}
headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer <token>"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "monitor": {
    "id": "string",
    "name": "string",
    "keywords": [
      "string"
    ],
    "exclude": [
      "string"
    ],
    "subreddits": [
      "string"
    ],
    "include_posts": true,
    "include_comments": true,
    "nsfw": true,
    "webhook_url": "string",
    "webhook_kind": "generic",
    "status": "active",
    "webhook_failing": true,
    "next_charge_at": "2019-08-24T14:15:22Z",
    "last_match_at": "2019-08-24T14:15:22Z",
    "created_at": "2019-08-24T14:15:22Z",
    "updated_at": "2019-08-24T14:15:22Z"
  }
}

{
  "error": "unauthorized: missing or invalid credentials",
  "error_code": "insufficient_credits"
}

{
  "error": "unauthorized: missing or invalid credentials",
  "error_code": "insufficient_credits"
}

{
  "error": "unauthorized: missing or invalid credentials",
  "error_code": "insufficient_credits"
}