Add more companies to an organization you started for someone.
Adds published companies to an unclaimed organization you created with `POST /v1/agent-signups`, so the three slots can be filled over several calls instead of all at once. Authenticate with the key that call returned; the organization is the one that key belongs to, and there is no way to name a different one. Companies are matched by name or domain against the ones we already track — no address you supply is ever fetched. The cap of three is on the TOTAL, so what is already on file counts, and anything that does not fit comes back in `shortfalls` and travels on the claim link. The link is updated to reflect what is now on file and what is still outstanding.
Required role: member or higher (organization-level).
Required scope: agent-signup:topup (for both OAuth2 tokens and API keys).
In: header
Request Body
application/json
TypeScript Definitions
Use the request body type in TypeScript.
Response Body
application/json
application/json
application/json
application/json
curl -X POST "https://api.competitortracker.io/v1/agent-signups/companies" \ -H "Content-Type: application/json" \ -d '{ "companies": [ "Asana" ] }'{
"status": "updated",
"organization": {
"id": "string",
"name": "string",
"expiresAt": "string"
},
"added": [
{
"requested": "string",
"id": "string",
"slug": "string",
"name": "string",
"url": "string",
"affiliated": true
}
],
"alreadyTracking": [
{
"requested": "string",
"id": "string",
"slug": "string",
"name": "string",
"url": "string",
"affiliated": true
}
],
"shortfalls": [
{
"ask": "string",
"reason": "unpublished"
}
],
"trackedCount": 0,
"slotsRemaining": 0,
"claim": {
"expiresAt": "string"
}
}{
"code": "string",
"message": "string",
"resolution": "string"
}{
"code": "string",
"message": "string",
"resolution": "string"
}{
"status": "catalog_unavailable",
"message": "string"
}Read what an agent set up for you and what taking it on will cost. GET
Public, and gated only by the token in the link. Returns the companies an agent put on file for you, the coins each one costs per cycle, anything from the original request we could not deliver and where the claim stands. Looking costs nothing and uses nothing up: the link works until you accept it, so you can read this, walk away and come back. A link past its deadline still answers with the same companies, so you can sign up in the ordinary way with them already selected.
Take on the companies an agent picked, into the organization you already have. POST
Adds the companies to your current organization under the ordinary rules, so your coins are spent exactly as they would be had you added each company yourself. Name any of them in `decline` to leave it out. The link is single-use and is spent here rather than on the preview. Every company comes back with its own outcome, so a balance that runs out part-way through is reported rather than rolled back: what fitted is on file and the rest is named. The organization the agent created is removed once the companies have moved across.