Skip to main content
POST
Follow an asset

Overview

Follow an asset to be emailed about it. Once you follow an asset, ChainPatrol emails you when:
  • its status changes to blocked or allowed, and
  • its takedown completes.
This is the same as clicking Follow on a takedown in the ChainPatrol app. Follows made here and in the app are the same follows, so either place can undo them. A follow belongs to a person, because that person is who gets the email. It needs a user-scoped API key or a signed-in session. Organization API keys have no person to email and are refused with 403.
To create a user-scoped key, open API Keys in your organization’s settings in the ChainPatrol app and choose the User key type (“for personal access”). Emails go to the address of the person the key belongs to.

Quick Start

Authentication

Include your user-scoped API key in the X-API-KEY header:

Example Request

Name the asset by its content (a URL, domain, address, social profile, …) or by its ChainPatrol assetId — exactly one of the two.

Request Body

Response

Following an asset you already follow is not an error — it returns the current state and does not use up any of your limit.

Errors

Authorizations

X-API-KEY
string
header
required

Your API key. This is required by most endpoints to access our API programatically. Reach out to us at support@chainpatrol.io to get an API key for your use.

Body

application/json

Follow an asset

The person behind the credentials is emailed when the asset's status changes (blocked or allowed) and when its takedown completes. Requires a user-scoped API key or a signed-in session — organization API keys have no person to notify and are refused.

Following an asset you already follow is not an error. One person can follow up to 100 assets per organization.

slug
string

Organization slug. Optional when your API key is scoped to one organization. Required when your credentials can reach more than one.

content
string

Asset content: a URL, domain, wallet address, social profile, etc.

Minimum string length: 1
assetId
integer

ChainPatrol asset ID

Required range: x > 0

Response

Successful response

assetId
integer
required

The asset that was followed or unfollowed

following
boolean
required

Whether this person now follows the asset

followCount
integer
required

How many assets this person follows in this organization

limit
integer
required

The most assets one person may follow

warnThreshold
integer
required

The count from which warning is set

canFollowMore
boolean
required

False once followCount reaches limit; following more is refused

warning
string | null
required

Set from warnThreshold upward, asking the caller to unfollow assets