PlatformDocs

3rd-Party Intent

See companies researching the topics you sell into, even before they visit your website.

Browse the topic catalogue, follow a topic, change its daily limit, pause it or stop it from your own code. Authenticated with ?privateKey=YOUR_KEY (see Authentication).

GET/admin/intent-topics/catalogGet available intent topics catalog
GET/admin/intent-topicsList intent topic subscriptions
POST/admin/intent-topicsSubscribe to an intent topic
PATCH/admin/intent-topicsUpdate an intent topic subscription
DELETE/admin/intent-topicsUnsubscribe from an intent topic
GET
Parameters
Website IdID of the website
curl -X GET "https://rest-dash.revealid.xyz/admin/intent-topics?privateKey=YOUR_KEY&websiteId=64b7f0a1c2d3e4f5a6b7c8d9"
Response
Press Send request to try it with sample data.

What each field accepts

FieldTypeLimits and formatAccepted values
websiteId*stringpattern ^[0-9a-fA-F]{24}$any

Use case: Start tracking a topic

Find its topicSlug with GET /admin/intent-topics/catalog, then POST /admin/intent-topics with { "websiteId": …, "topicSlug": "crm-software", "userDailyLimit": 20 }. Calling it again for a topic you already follow updates the limit and resumes it if paused; nothing is duplicated.

Use case: Pause over the holidays

PATCH /admin/intent-topics with { "websiteId": …, "topicSlug": …, "paused": true }; send "paused": false to resume. Counters and leads are kept. DELETE /admin/intent-topics stops the topic for good (its leads stay).

Use case: Is intent on for this website?

GET /admin/intent-topics returns featureEnabled: false and an empty list when intent is not switched on for the website, instead of an error.

On this page