{"openapi":"3.1.0","info":{"title":"GEOboom API","version":"1","description":"Everything GEOboom does for an organisation, for your own software or an AI agent. Authenticate with `Authorization: Bearer <key>`; keys are made by an owner in Settings → Integrations. The API only grows within v1: fields and operations are added, never renamed or removed while in use, and values described as an open set may gain new members."},"servers":[{"url":"https://api.geoboom.io/v1"}],"components":{"securitySchemes":{"key":{"type":"http","scheme":"bearer"}}},"security":[{"key":[]}],"paths":{"/blurbs":{"get":{"operationId":"blurbs.list","summary":"Blurbs, newest first: our entries written for publishers' articles (side ours) and the copy publishers sent for our project's site, read out of their threads (side theirs). Each with its words, its table line, the article it goes into and the thread it belongs to. Filter by project, by thread (conversationId, with topicKey to narrow to one subject), by side, or by text in the address or words.","x-scope":"read","x-effect":"read","parameters":[{"name":"projectId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"conversationId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"topicKey","in":"query","required":false,"schema":{"description":"With conversationId: one subject of that conversation","type":"string","minLength":1}},{"name":"side","in":"query","required":false,"schema":{"type":"string","enum":["ours","theirs"]}},{"name":"q","in":"query","required":false,"schema":{"description":"Text in the article address, the words or the publisher's domain","type":"string","maxLength":200}},{"name":"limit","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"side":{"type":"string","description":"ours: our entry for the publisher's article (hostUrl is their page). theirs: the copy the publisher sent for our project's site, read out of the thread (hostUrl is our page)."},"projectId":{"type":"string"},"conversationId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The thread it was written in or read from, for threads.get"},"topicKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"hostUrl":{"type":"string","description":"The article the words go into"},"authorDomain":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"theirs: the publisher's site that wrote it"},"body":{"type":"string","description":"The entry, in Markdown, links as [anchor](url)"},"tableRow":{"type":"string","description":"Its line for the article's comparison table, if the article has one; else empty"},"edited":{"type":"boolean","description":"ours: a person changed what the model wrote"},"author":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ours: who asked for it"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","side","projectId","conversationId","topicKey","hostUrl","authorDomain","body","tableRow","edited","author","createdAt","updatedAt"],"additionalProperties":false}}},"required":["rows"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/blurbs/{blurbId}":{"get":{"operationId":"blurbs.get","summary":"One blurb in full: its words and table line, what the model first wrote (ours) and what it was asked, its link and anchor, what the model could not fill (gaps), where the words came from in the thread (theirs: messages, attachments, Google Docs), how the thread changed them, and every link shared with the publisher. A theirs blurb can be put on the project's WordPress site with sites.publish (blurbId).","x-scope":"read","x-effect":"read","parameters":[{"name":"blurbId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"side":{"type":"string","description":"ours: our entry for the publisher's article (hostUrl is their page). theirs: the copy the publisher sent for our project's site, read out of the thread (hostUrl is our page)."},"projectId":{"type":"string"},"conversationId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The thread it was written in or read from, for threads.get"},"topicKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"hostUrl":{"type":"string","description":"The article the words go into"},"authorDomain":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"theirs: the publisher's site that wrote it"},"body":{"type":"string","description":"The entry, in Markdown, links as [anchor](url)"},"tableRow":{"type":"string","description":"Its line for the article's comparison table, if the article has one; else empty"},"edited":{"type":"boolean","description":"ours: a person changed what the model wrote"},"author":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ours: who asked for it"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"originalBody":{"type":"string","description":"ours: the model's words before anybody edited them"},"originalTableRow":{"type":"string"},"instructions":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ours: what the model was asked for this entry"},"anchor":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Where the entry's main link points"},"shape":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ours: the pattern of the article's entries the words follow"},"gaps":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"ours: what the article's entries carry that nothing could fill"},"sources":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","description":"message, attachment or doc. An open set"},"messageId":{"type":"string"},"attachmentId":{"type":"string"},"filename":{"type":"string"},"url":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"at":{"anyOf":[{"type":"string"},{"type":"null"}]},"by":{"type":"string"}},"required":["kind"],"additionalProperties":false},"description":"theirs: where in the thread the words came from"},"history":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","description":"first, text, file or doc. An open set"},"summary":{"anyOf":[{"type":"string"},{"type":"null"}]},"at":{"anyOf":[{"type":"string"},{"type":"null"}]},"body":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","summary","at","body"],"additionalProperties":false}},"shares":{"type":"array","items":{"type":"object","properties":{"url":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The page the publisher was sent"},"sharedAt":{"type":"string"},"revokedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"sharedBy":{"anyOf":[{"type":"string"},{"type":"null"}]},"stale":{"type":"boolean","description":"The draft has changed since this link was made"}},"required":["url","sharedAt","revokedAt","sharedBy","stale"],"additionalProperties":false}}},"required":["id","side","projectId","conversationId","topicKey","hostUrl","authorDomain","body","tableRow","edited","author","createdAt","updatedAt","originalBody","originalTableRow","instructions","anchor","targetUrl","shape","gaps","sources","history","shares"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}":{"get":{"operationId":"campaigns.get","summary":"One campaign's settings (name, kind, pitch, templates, mailboxes, send rules, budget, paused) and the templates and mailboxes it may be set to.","x-scope":"read","x-effect":"read","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string","description":"What it is for. Today one of links, geo; an open set."},"paused":{"type":"boolean","description":"Nothing is sent while paused; research carries on"},"launchedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"When it was first resumed; null if it never has been"},"archived":{"type":"boolean"},"pitch":{"type":"object","properties":{"own":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"This campaign's pitch type; null follows the project's"},"effective":{"type":"string","description":"What it offers publishers. Today one of exchange, exchange_or_paid, paid"},"project":{"type":"string"}},"required":["own","effective","project"],"additionalProperties":false},"templates":{"type":"object","properties":{"mode":{"type":"string","description":"auto: every live email template of the pitch type; manual: the chosen list"},"sendsWith":{"type":"array","items":{"type":"string"},"description":"Template ids it would send with now; empty means it cannot schedule"},"chosen":{"type":"array","items":{"type":"string"},"description":"The manual list, kept while on auto"},"automatic":{"type":"object","properties":{"pitch":{"type":"string"},"ids":{"type":"array","items":{"type":"string"}}},"required":["pitch","ids"],"additionalProperties":false}},"required":["mode","sendsWith","chosen","automatic"],"additionalProperties":false},"mailboxIds":{"type":"array","items":{"type":"string"},"description":"Mailboxes it sends from; empty means all of the project's"},"sendRules":{"type":"object","properties":{"publisherLimit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Most people written to at one publisher"},"publisherGapDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Days between people at one publisher; null is the default"},"includeCatchAll":{"type":"boolean","description":"Whether addresses that cannot be verified count as reachable"},"donorPageLimit":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["publisherLimit","publisherGapDays","includeCatchAll","donorPageLimit"],"additionalProperties":false},"excludeCompetitors":{"type":"object","properties":{"own":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"null follows the pitch: on for paid"},"effective":{"type":"boolean","description":"Publishers whose own site is the client's competitor are left out"}},"required":["own","effective"],"additionalProperties":false},"autoFilter":{"type":"boolean"},"autoSchedule":{"type":"boolean"},"rankBy":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"dir":{"type":"string"}},"required":["key","dir"],"additionalProperties":false},{"type":"null"}],"description":"The column it ranks on; null is the default for its kind"},"creditAllowance":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Whole credits a month this campaign may commit; null is the default"},"options":{"type":"object","properties":{"templates":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"pitchType":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","name","pitchType"],"additionalProperties":false}},"mailboxes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"handle":{"type":"string"},"senderName":{"anyOf":[{"type":"string"},{"type":"null"}]},"dailyCap":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"New conversations it may open in a day"},"status":{"type":"string"}},"required":["id","handle","senderName","dailyCap","status"],"additionalProperties":false}}},"required":["templates","mailboxes"],"additionalProperties":false},"followUpGapDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The organisation's days between a first email and its follow-up"}},"required":["id","projectId","name","kind","paused","launchedAt","archived","pitch","templates","mailboxIds","sendRules","excludeCompetitors","autoFilter","autoSchedule","rankBy","creditAllowance","options","followUpGapDays"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}},"patch":{"operationId":"campaigns.update","summary":"Change a campaign's settings: name, kind, pitch type, templates, mailboxes, send rules, competitor exclusion, auto-filter, ranking, archived. Only the fields sent change. Returns the settings as they now are.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"kind":{"type":"string","enum":["links","geo"]},"pitchType":{"description":"What it offers publishers; null follows the project. Changes which templates auto mode sends","anyOf":[{"type":"string","enum":["exchange","exchange_or_paid","paid"]},{"type":"null"}]},"templateMode":{"type":"string","enum":["auto","manual"]},"templateIds":{"description":"The manual list, in the order a batch deals them; used when templateMode is manual","minItems":1,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"mailboxIds":{"description":"Mailboxes it sends from, of the project's; empty means all","type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"sendRules":{"type":"object","properties":{"publisherLimit":{"description":"Most people written to at one publisher, 1–50","anyOf":[{"type":"number"},{"type":"null"}]},"publisherGapDays":{"description":"Days between people at one publisher, 0–365; null is the default","anyOf":[{"type":"number"},{"type":"null"}]},"includeCatchAll":{"type":"boolean"},"donorPageLimit":{"anyOf":[{"type":"number"},{"type":"null"}]}}},"excludeCompetitors":{"description":"null follows the pitch: on for paid","anyOf":[{"type":"boolean"},{"type":"null"}]},"archived":{"type":"boolean"},"autoFilter":{"description":"Decide undecided URLs by the campaign's rules as facts arrive","type":"boolean"},"rankBy":{"description":"A column key from the import, `rank`, or `position`","type":"object","properties":{"key":{"type":"string","minLength":1},"dir":{"type":"string","enum":["asc","desc"]}},"required":["key","dir"]}},"required":[]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string","description":"What it is for. Today one of links, geo; an open set."},"paused":{"type":"boolean","description":"Nothing is sent while paused; research carries on"},"launchedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"When it was first resumed; null if it never has been"},"archived":{"type":"boolean"},"pitch":{"type":"object","properties":{"own":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"This campaign's pitch type; null follows the project's"},"effective":{"type":"string","description":"What it offers publishers. Today one of exchange, exchange_or_paid, paid"},"project":{"type":"string"}},"required":["own","effective","project"],"additionalProperties":false},"templates":{"type":"object","properties":{"mode":{"type":"string","description":"auto: every live email template of the pitch type; manual: the chosen list"},"sendsWith":{"type":"array","items":{"type":"string"},"description":"Template ids it would send with now; empty means it cannot schedule"},"chosen":{"type":"array","items":{"type":"string"},"description":"The manual list, kept while on auto"},"automatic":{"type":"object","properties":{"pitch":{"type":"string"},"ids":{"type":"array","items":{"type":"string"}}},"required":["pitch","ids"],"additionalProperties":false}},"required":["mode","sendsWith","chosen","automatic"],"additionalProperties":false},"mailboxIds":{"type":"array","items":{"type":"string"},"description":"Mailboxes it sends from; empty means all of the project's"},"sendRules":{"type":"object","properties":{"publisherLimit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Most people written to at one publisher"},"publisherGapDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Days between people at one publisher; null is the default"},"includeCatchAll":{"type":"boolean","description":"Whether addresses that cannot be verified count as reachable"},"donorPageLimit":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["publisherLimit","publisherGapDays","includeCatchAll","donorPageLimit"],"additionalProperties":false},"excludeCompetitors":{"type":"object","properties":{"own":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"null follows the pitch: on for paid"},"effective":{"type":"boolean","description":"Publishers whose own site is the client's competitor are left out"}},"required":["own","effective"],"additionalProperties":false},"autoFilter":{"type":"boolean"},"autoSchedule":{"type":"boolean"},"rankBy":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"dir":{"type":"string"}},"required":["key","dir"],"additionalProperties":false},{"type":"null"}],"description":"The column it ranks on; null is the default for its kind"},"creditAllowance":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Whole credits a month this campaign may commit; null is the default"}},"required":["id","projectId","name","kind","paused","launchedAt","archived","pitch","templates","mailboxIds","sendRules","excludeCompetitors","autoFilter","autoSchedule","rankBy","creditAllowance"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/allowance":{"post":{"operationId":"campaigns.setAllowance","summary":"Set the whole credits a month a campaign may commit to new publishers; null is the default.","x-scope":"prospecting:spend","x-effect":"write","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"credits":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["credits"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"creditAllowance":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["creditAllowance"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/auto-filter":{"get":{"operationId":"prospects.planAutoFilter","summary":"What the auto-filter would decide for a campaign's undecided URLs: how many become fits, how many are ruled out and by which rule, and how many it cannot decide yet and why.","x-scope":"read","x-effect":"read","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"undecided":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"fit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"notFit":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","description":"The rule. An open set"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["reason","count"],"additionalProperties":false}},"leftAlone":{"type":"array","items":{"type":"object","properties":{"reason":{"type":"string","description":"Why it cannot be decided yet. An open set"},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["reason","count"],"additionalProperties":false}},"drFloor":{"type":"number","description":"The lowest Domain Rating it keeps"},"ownDomain":{"anyOf":[{"type":"string"},{"type":"null"}]},"ownDomainRating":{"anyOf":[{"type":"number"},{"type":"null"}]},"competitors":{"type":"boolean","description":"Whether it leaves competitors out"}},"required":["undecided","fit","notFit","leftAlone","drFloor","ownDomain","ownDomainRating","competitors"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}},"post":{"operationId":"prospects.autoFilter","summary":"Decide a campaign's undecided URLs by its rules (see planAutoFilter). URLs missing a fact stay undecided, and the fact is asked for; run it again later to decide them.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"fit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"notFit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"asked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Publishers whose missing facts were asked for"}},"required":["fit","notFit","asked"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/auto-schedule":{"post":{"operationId":"campaigns.setAutoSchedule","summary":"Turn automatic scheduling of a campaign's fits on or off.","x-scope":"prospecting:spend","x-effect":"write","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"autoSchedule":{"type":"boolean"}},"required":["autoSchedule"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"autoSchedule":{"type":"boolean"}},"required":["autoSchedule"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/competitors":{"post":{"operationId":"prospects.markCompetitor","summary":"Say whether these URLs' publishers are the client's competitors, overruling the automatic check. Verdicts do not change; the auto-filter uses the answer for URLs not decided yet.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"targetIds":{"maxItems":500,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"competitor":{"type":"boolean"}},"required":["targetIds","competitor"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"domains":{"type":"array","items":{"type":"string"},"description":"The publishers marked"}},"required":["domains"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/pause":{"post":{"operationId":"campaigns.pause","summary":"Pause a campaign: nothing more is sent from it until it is resumed. Research carries on and nothing queued is lost; replies still arrive. Pausing a paused campaign changes nothing.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"paused":{"type":"boolean","const":true},"held":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Queued URLs now waiting for it to be resumed"}},"required":["paused","held"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/prospecting":{"get":{"operationId":"prospecting.get","summary":"How a campaign gets its prospects: which source is live (manual, seranking, keywords or prompts) and each source's setup and last run. Only the live source adds prospects on its schedule.","x-scope":"read","x-effect":"read","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"mode":{"type":"string","description":"manual, seranking, keywords or prompts. An open set."},"manual":{"type":"object","properties":{"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"lastAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["imported","lastAt"],"additionalProperties":false},"seranking":{"anyOf":[{"type":"object","properties":{"projectName":{"anyOf":[{"type":"string"},{"type":"null"}]},"schedule":{"type":"string"},"lastImportedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastFailedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["projectName","schedule","lastImportedAt","lastFailedAt"],"additionalProperties":false},{"type":"null"}]},"keywords":{"anyOf":[{"type":"object","properties":{"keywords":{"type":"array","items":{"type":"string"}},"surface":{"type":"string","description":"organic or ai_overview: which half of the Google result is the evidence, from the campaign's kind"},"serpDepth":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"topN":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"schedule":{"type":"string","description":"off, weekly or monthly"},"locationCode":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"languageCode":{"type":"string"},"lastRunAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastError":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["keywords","surface","serpDepth","topN","schedule","locationCode","languageCode","lastRunAt","lastError"],"additionalProperties":false},{"type":"null"}]},"prompts":{"anyOf":[{"type":"object","properties":{"prompts":{"type":"array","items":{"type":"string"}},"engines":{"type":"array","items":{"type":"string"}},"topN":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"windowDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"How far back the answer count looks"},"schedule":{"type":"string","description":"off, daily, weekly or monthly"},"locationCode":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"languageCode":{"type":"string"},"lastRunAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastFailedAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["prompts","engines","topN","windowDays","schedule","locationCode","languageCode","lastRunAt","lastFailedAt"],"additionalProperties":false},{"type":"null"}]}},"required":["mode","manual","seranking","keywords","prompts"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/prospecting/keywords":{"put":{"operationId":"prospecting.saveKeywords","summary":"Set up a campaign's keyword source: up to 1000 keywords whose search results are read for prospects, how deep to read (serpDepth 10–100), how many candidates to keep (topN 10–5000), how often to run on its own (off, weekly, monthly) and the market. Replaces the previous list. Running it is prospecting.run.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"keywords":{"anyOf":[{"type":"string"},{"maxItems":5000,"type":"array","items":{"type":"string","maxLength":500}}],"description":"Keywords: an array, or one per line"},"serpDepth":{"default":20,"type":"number"},"topN":{"default":500,"type":"number"},"schedule":{"default":"off","type":"string"},"market":{"default":"US","description":"A market code: US, GB, CA, AU, DE, FR, ES, UA. Anything else means US.","type":"string"},"languageCode":{"default":"en","type":"string","maxLength":10}},"required":["keywords"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["count"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/prospecting/mode":{"put":{"operationId":"prospecting.setMode","summary":"Choose which source adds prospects to a campaign on its schedule: manual (nobody), seranking, keywords or prompts. The source must be set up first. Other sources keep their setup.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"mode":{"type":"string"}},"required":["mode"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"mode":{"type":"string"}},"required":["mode"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/prospecting/prompts":{"put":{"operationId":"prospecting.savePrompts","summary":"Set up a campaign's prompt source: up to 500 questions put to AI answer engines (chatgpt), whose cited pages become prospects; how many to keep (topN 10–5000), how far back the answer count looks (windowDays 1–365), how often to run on its own (off, daily, weekly, monthly) and the market. Replaces the previous list. Running it is prospecting.run.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"prompts":{"anyOf":[{"type":"string"},{"maxItems":5000,"type":"array","items":{"type":"string","maxLength":500}}],"description":"Prompts: an array, or one per line"},"engines":{"default":[],"type":"array","items":{"type":"string"}},"topN":{"default":500,"type":"number"},"windowDays":{"default":30,"type":"number"},"schedule":{"default":"off","type":"string"},"market":{"default":"US","description":"A market code: US, GB, CA, AU, DE, FR, ES, UA. Anything else means US.","type":"string"},"languageCode":{"default":"en","type":"string","maxLength":10}},"required":["prompts"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["count"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/prospecting/runs":{"post":{"operationId":"prospecting.run","summary":"Run a campaign's keyword or prompt source now: search results or AI answers are bought, their pages scored, and the best become prospects to decide on. Returns at once; follow it with jobs.get (jobId) and prospecting.latestRun (after = startedAfter). One run at a time per campaign.","x-scope":"prospecting:spend","x-effect":"spend","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":8,"maxLength":255,"description":"Made once per intended action (a UUID) and sent unchanged on every retry of it. A retry gets the first call's answer, with `Idempotent-Replayed: true`, instead of acting twice. Kept for 7 days."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"source":{"type":"string","enum":["keywords","prompts"],"description":"Which source to run; it need not be the live one"}},"required":["source"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"jobId":{"anyOf":[{"type":"string"},{"type":"null"}]},"startedAfter":{"type":"string","description":"Pass as `after` to prospecting.latestRun"}},"required":["jobId","startedAfter"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/prospecting/runs/latest":{"get":{"operationId":"prospecting.latestRun","summary":"A campaign's newest prospecting run, with its progress counters. Pass `after` (startedAfter from prospecting.run) to get only the run you started: null means it has not begun yet. Finished when finishedAt is set.","x-scope":"read","x-effect":"read","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"after","in":"query","required":false,"schema":{"type":"string"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"run":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"live":{"type":"boolean"},"kind":{"type":"string","description":"keywords or prompts"},"phase":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"serps, answers, scoring, pricing or promoting while it runs. An open set."},"keywordsTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"keywordsDone":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"domainsTotal":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"domainsDone":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"priced":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"array","items":{"type":"string"},"description":"Keywords with no search volume on record, scanned anyway"},"failed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Keywords whose results could not be read; not a failed run"},"candidates":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"imported":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Prospects this run added to the campaign"},"taken":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"already":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Candidates an earlier run had already added"},"error":{"anyOf":[{"type":"string"},{"type":"null"}]},"startedAt":{"type":"string"},"finishedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"held":{"type":"boolean","description":"GEOboom is looking into this campaign's runs; a new one cannot start until released"},"health":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","live","kind","phase","keywordsTotal","keywordsDone","domainsTotal","domainsDone","priced","skipped","failed","candidates","imported","taken","already","error","startedAt","finishedAt","held","health"],"additionalProperties":false},{"type":"null"}]}},"required":["run"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/prospects":{"get":{"operationId":"prospects.list","summary":"A campaign's prospect URLs, filtered by where they stand (undecided, fit, not_fit, scheduled, all_fit, all), most valuable first. Each row says whether its verdict can still be changed.","x-scope":"read","x-effect":"read","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"state","in":"query","required":false,"schema":{"default":"undecided","description":"One of undecided, fit, not_fit, scheduled, all_fit, all. Anything else, or nothing, means undecided.","type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"default":"value","description":"One of value, position, dr. Anything else, or nothing, means value.","type":"string"}},{"name":"page","in":"query","required":false,"schema":{"default":1,"type":"integer","minimum":1,"maximum":9007199254740991}},{"name":"size","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"targetId":{"type":"string"},"url":{"type":"string"},"domain":{"type":"string"},"position":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Its line in the import"},"verdict":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"fit, not_fit, or null for undecided"},"verdictReason":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Set when a rule decided it rather than a person"},"verdictBy":{"anyOf":[{"type":"string"},{"type":"null"}]},"locked":{"type":"boolean","description":"On the queue, so the verdict can no longer change"},"status":{"type":"string","description":"How far the research and this campaign's conversation got. An open set."},"fetchError":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why the page could not be read, if it could not"},"pageKind":{"anyOf":[{"type":"string"},{"type":"null"}]},"domainRating":{"anyOf":[{"type":"number"},{"type":"null"}]},"pageTraffic":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"The page's monthly organic visits"},"valueUsd":{"anyOf":[{"type":"number"},{"type":"null"}],"description":"What a placement here is worth, in dollars"},"contacts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"emailable":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Contacts with an address that is not known bad"},"knownAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Somebody at this publisher who already knows us"},"publisherRelation":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the publisher is to the client: competitor, adjacent, unrelated, unclear; null unchecked"},"queue":{"anyOf":[{"type":"object","properties":{"status":{"type":"string"},"holdReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"notBefore":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]}},"required":["status","holdReason","notBefore"],"additionalProperties":false},{"type":"null"}]},"attributes":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{},"description":"The columns the client's import brought"}},"required":["targetId","url","domain","position","verdict","verdictReason","verdictBy","locked","status","fetchError","pageKind","domainRating","pageTraffic","valueUsd","contacts","emailable","knownAt","publisherRelation","queue","attributes"],"additionalProperties":false}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Rows in this state"},"counts":{"type":"object","properties":{"undecided":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"fit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"not_fit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"all_fit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["undecided","fit","not_fit","scheduled","all_fit","all"],"additionalProperties":false},"applied":{"type":"object","properties":{"state":{"type":"string"},"sort":{"type":"string"},"page":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"size":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["state","sort","page","size"],"additionalProperties":false}},"required":["rows","total","counts","applied"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}},"post":{"operationId":"prospects.import","summary":"Add URLs to a campaign: `urls` as a list, or `csv` as a table whose other columns are kept (the URL column, rank and goal are inferred unless `mapping` says). URLs already on the campaign are skipped; ones the project already holds join it. New pages start being read at once.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"urls":{"maxItems":20000,"type":"array","items":{"type":"string","maxLength":2000}},"csv":{"description":"Comma, tab or semicolon separated, with a header row","type":"string","maxLength":4000000},"mapping":{"description":"How to take each column of `csv`; inferred when absent","type":"array","items":{"type":"object","properties":{"index":{"type":"integer","minimum":0,"maximum":9007199254740991},"header":{"type":"string"},"key":{"type":"string"},"role":{"type":"string","enum":["url","goal","rank","custom","ignore"]},"type":{"type":"string","enum":["number","text","date"]},"samples":{"default":[],"type":"array","items":{"type":"string"}}},"required":["index","header","key","role","type"]}},"filename":{"type":"string","maxLength":200}},"required":[]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"added":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"New to this campaign"},"joinedFromProject":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of those, pages the project already held"},"duplicatesInCampaign":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"duplicatesInFile":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"invalid":{"type":"array","items":{"type":"object","properties":{"line":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"value":{"type":"string"}},"required":["line","value"],"additionalProperties":false},"description":"Rows with no readable URL"},"queued":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"New pages that started being read"},"dropped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Left out because a limit was reached; the top of the file was kept"},"droppedBy":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"campaign or project: which limit"},"mapping":{"type":"array","items":{"type":"object","properties":{"header":{"type":"string"},"key":{"type":"string"},"role":{"type":"string"},"type":{"type":"string"}},"required":["header","key","role","type"],"additionalProperties":false}}},"required":["added","joinedFromProject","duplicatesInCampaign","duplicatesInFile","invalid","queued","dropped","droppedBy","mapping"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/prospects/remove":{"post":{"operationId":"prospects.remove","summary":"Take URLs off a campaign. Only the campaign's membership goes; the page, its contacts and its messages stay, and importing the URL again brings it back.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"targetIds":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["targetIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"removed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["removed"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/resume":{"post":{"operationId":"campaigns.resume","summary":"Launch or resume a campaign. If resuming commits credits, the first call answers with the cost and the credit picture instead; call again with that cost as agreedCost to go ahead.","x-scope":"mail:send","x-effect":"spend","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":8,"maxLength":255,"description":"Made once per intended action (a UUID) and sent unchanged on every retry of it. A retry gets the first call's answer, with `Idempotent-Replayed: true`, instead of acting twice. Kept for 7 days."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"agreedCost":{"description":"The cost a previous call answered with, to go ahead","type":"number"}},"required":[]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"confirm"},"cost":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Hundredths of a credit, charged as each publisher's first email goes"},"picture":{"type":"object","properties":{"cost":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Hundredths of a credit"},"reserved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paused":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Why the organisation's sending is paused, if it is"},"campaignPaused":{"type":"boolean"},"budget":{"type":"object","properties":{"left":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"which":{"type":"string","description":"campaign or project: whose monthly budget is the tighter"},"month":{"type":"string"},"resumes":{"type":"string","description":"When the budget renews"}},"required":["left","limit","which","month","resumes"],"additionalProperties":false}},"required":["cost","available","reserved","paused","campaignPaused","budget"],"additionalProperties":false}},"required":["status","cost","picture"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"resumed"},"released":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Held URLs asked again"},"firstSend":{"description":"On the organisation's first launch: when the first email can go","anyOf":[{"type":"string"},{"type":"null"}]}},"required":["status","released"],"additionalProperties":false}]}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/skip":{"post":{"operationId":"prospects.skip","summary":"Stop everything still to go to these URLs from a campaign: unsent pitches are skipped and follow-ups of sent ones withdrawn. Threads they answered are left alone.","x-scope":"campaigns:write","x-effect":"outward","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":8,"maxLength":255,"description":"Made once per intended action (a UUID) and sent unchanged on every retry of it. A retry gets the first call's answer, with `Idempotent-Replayed: true`, instead of acting twice. Kept for 7 days."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"targetIds":{"maxItems":500,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["targetIds"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Unsent pitches skipped"},"withdrawn":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Sequences withdrawn at the mail provider"}},"required":["skipped","withdrawn"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/campaigns/{campaignId}/verdicts":{"post":{"operationId":"prospects.setVerdict","summary":"Mark a campaign's URLs a fit, not a fit, or undecided again (null). A fit is searched for contacts. URLs already on the queue keep their verdict and are counted as locked.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"campaignId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"targetIds":{"minItems":1,"maxItems":500,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"verdict":{"anyOf":[{"type":"string","enum":["fit","not_fit"]},{"type":"null"}]}},"required":["targetIds","verdict"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"decided":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"URLs whose verdict is now the one asked for"},"locked":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"On the queue, so left as they were"},"notOnCampaign":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Ids that are not this campaign's URLs"}},"required":["decided","locked","notOnCampaign"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/contacts":{"get":{"operationId":"contacts.list","summary":"List people at publishers this organisation has found or written to, with how warm each is, the sites they answer for, and whether a thread with them is owed an answer. Search by name, address or company; optionally narrow to one project.","x-scope":"read","x-effect":"read","parameters":[{"name":"projectId","in":"query","required":false,"schema":{"description":"Only people at publishers with URLs in this project","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"description":"Matches part of the name, address or company","anyOf":[{"type":"string"},{"type":"null"}]}},{"name":"standing","in":"query","required":false,"schema":{"default":"warm","description":"One of warm, reaching_out, all. Anything else, or nothing, means warm.","type":"string"}},{"name":"page","in":"query","required":false,"schema":{"default":1,"type":"integer","minimum":1,"maximum":9007199254740991}},{"name":"size","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"contactId":{"type":"string"},"who":{"type":"string","description":"Their name, or their address when we have no name"},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailStatus":{"type":"string","description":"Whether the address is verified. An open set: tolerate values not listed here."},"company":{"anyOf":[{"type":"string"},{"type":"null"}]},"companyLogo":{"anyOf":[{"type":"string"},{"type":"null"}]},"avatar":{"anyOf":[{"type":"string"},{"type":"null"}]},"warmth":{"anyOf":[{"type":"string","description":"How warm: introduced, forwarded, in_contact. An open set: tolerate values not listed here."},{"type":"null"}]},"warmReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"warmSince":{"anyOf":[{"type":"string"},{"type":"null"}]},"answered":{"type":"boolean","description":"They have written to us"},"domains":{"type":"array","items":{"type":"string"},"description":"Sites they answer for"},"urls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"projects":{"type":"array","items":{"type":"string"}},"lastAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"awaiting":{"type":"boolean","description":"A thread with them is owed an answer"},"followUp":{"type":"boolean","description":"A thread with them is owed a chase"},"threads":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"forwardedTo":{"type":"array","items":{"type":"string"}}},"required":["contactId","who","email","emailStatus","company","companyLogo","avatar","warmth","warmReason","warmSince","answered","domains","urls","projects","lastAt","awaiting","followUp","threads","forwardedTo"],"additionalProperties":false}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"applied":{"type":"object","properties":{"projectId":{"anyOf":[{"type":"string"},{"type":"null"}]},"q":{"anyOf":[{"type":"string"},{"type":"null"}]},"standing":{"type":"string"},"page":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"size":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["standing","page","size"],"additionalProperties":false}},"required":["rows","total","applied"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/contacts/{contactId}":{"get":{"operationId":"contacts.get","summary":"Everything known about one person at a publisher: name, address and whether it is verified, role, how warm they are and why, their employer, the sites they answer for with our URLs on each, their threads (and which are owed an answer), notes and messages.","x-scope":"read","x-effect":"read","parameters":[{"name":"contactId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"contact":{"type":"object","properties":{"id":{"type":"string"},"fullName":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailStatus":{"type":"string","description":"Whether the address is verified. An open set: tolerate values not listed here."},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"company":{"anyOf":[{"type":"string"},{"type":"null"}]},"domain":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedinUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"xUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"country":{"anyOf":[{"type":"string"},{"type":"null"}]},"source":{"anyOf":[{"type":"string","description":"How we found them. An open set: tolerate values not listed here."},{"type":"null"}]},"warmth":{"anyOf":[{"type":"string","description":"introduced, forwarded, in_contact. An open set: tolerate values not listed here."},{"type":"null"}]},"warmSince":{"anyOf":[{"type":"string"},{"type":"null"}]},"warmReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"affiliation":{"anyOf":[{"type":"string","description":"How they relate to the publisher. An open set: tolerate values not listed here."},{"type":"null"}]}},"required":["id","fullName","email","emailStatus","jobTitle","company","domain","linkedinUrl","xUrl","country","source","warmth","warmSince","warmReason","affiliation"],"additionalProperties":false},"employer":{"anyOf":[{"type":"object","properties":{"domain":{"type":"string"},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"about":{"anyOf":[{"type":"string"},{"type":"null"}]},"size":{"anyOf":[{"type":"string"},{"type":"null"}]},"headquarters":{"anyOf":[{"type":"string"},{"type":"null"}]},"founded":{"anyOf":[{"type":"number"},{"type":"null"}]},"industries":{"anyOf":[{"type":"string"},{"type":"null"}]},"linkedinUrl":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["domain","name","about","size","headquarters","founded","industries","linkedinUrl"],"additionalProperties":false},{"type":"null"}]},"domains":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string"},"urls":{"type":"array","items":{"type":"object","properties":{"targetId":{"type":"string"},"url":{"type":"string"},"status":{"type":"string","description":"The URL's status. An open set: tolerate values not listed here."},"project":{"type":"string"},"projectId":{"type":"string"},"campaignId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["targetId","url","status","project","projectId","campaignId"],"additionalProperties":false}}},"required":["domain","urls"],"additionalProperties":false}},"threads":{"type":"array","items":{"type":"object","properties":{"conversationId":{"type":"string"},"topicKey":{"type":"string"},"title":{"type":"string"},"channel":{"type":"string","description":"email, linkedin. An open set: tolerate values not listed here."},"projectId":{"anyOf":[{"type":"string"},{"type":"null"}]},"project":{"anyOf":[{"type":"string"},{"type":"null"}]},"at":{"anyOf":[{"type":"string"},{"type":"null"}]},"awaiting":{"type":"boolean","description":"Owed an answer"}},"required":["conversationId","topicKey","title","channel","projectId","project","at","awaiting"],"additionalProperties":false}},"history":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"at":{"type":"string"},"kind":{"type":"string","description":"message or note. An open set: tolerate values not listed here."},"direction":{"anyOf":[{"type":"string"},{"type":"null"}]},"body":{"type":"string"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"actor":{"anyOf":[{"type":"string"},{"type":"null"}]},"project":{"anyOf":[{"type":"string"},{"type":"null"}]},"conversationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"topicKey":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","at","kind","direction","body","subject","actor","project","conversationId","topicKey"],"additionalProperties":false}},"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"direction":{"type":"string","description":"inbound or outbound. An open set: tolerate values not listed here."},"status":{"type":"string","description":"The message's status. An open set: tolerate values not listed here."},"from":{"anyOf":[{"type":"string"},{"type":"null"}]},"to":{"type":"array","items":{"type":"string"}},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"at":{"type":"string"},"conversationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"topicKey":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","direction","status","from","to","subject","at","conversationId","topicKey"],"additionalProperties":false}}},"required":["contact","employer","domains","threads","history","messages"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/deals":{"get":{"operationId":"deals.list","summary":"This organisation's deals, newest activity first: who with, what each side gives, the price, and the state read off the placements (agreed, partly_live, live, broken or archived. An open set.). Filter by project, state, or text.","x-scope":"read","x-effect":"read","parameters":[{"name":"projectId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"state","in":"query","required":false,"schema":{"type":"string"}},{"name":"q","in":"query","required":false,"schema":{"type":"string","maxLength":200}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","description":"agreed, partly_live, live, broken or archived. An open set."},"projectId":{"type":"string"},"project":{"type":"string"},"publisherDomain":{"anyOf":[{"type":"string"},{"type":"null"}]},"contactId":{"anyOf":[{"type":"string"},{"type":"null"}]},"who":{"anyOf":[{"type":"string"},{"type":"null"}]},"oursGives":{"type":"string","description":"placement or payment"},"theirsGives":{"type":"string","description":"placement or payment"},"oursAmountCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"theirsAmountCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"owed":{"type":"boolean","description":"They have billed us and it is not marked paid"},"ours":{"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"live":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"On the page, as somebody asserted"},"seen":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of those, confirmed by a check and still as agreed"},"gone":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Was up and is not, or was claimed and cannot be found"},"wrong":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Up, but no longer on the agreed terms"},"blind":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Could not be checked for days running"}},"required":["total","live","seen","gone","wrong","blind"],"additionalProperties":false},"theirs":{"type":"object","properties":{"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"live":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"On the page, as somebody asserted"},"seen":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Of those, confirmed by a check and still as agreed"},"gone":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Was up and is not, or was claimed and cannot be found"},"wrong":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Up, but no longer on the agreed terms"},"blind":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Could not be checked for days running"}},"required":["total","live","seen","gone","wrong","blind"],"additionalProperties":false},"threads":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"needsUpdate":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Things a thread raised that are not written into the deal yet"},"createdAt":{"type":"string"},"updatedAt":{"type":"string"}},"required":["id","title","state","projectId","project","publisherDomain","contactId","who","oursGives","theirsGives","oursAmountCents","theirsAmountCents","currency","owed","ours","theirs","threads","needsUpdate","createdAt","updatedAt"],"additionalProperties":false}}},"required":["rows"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}},"post":{"operationId":"deals.create","summary":"Write a deal down: who it is with (email; a new address becomes a contact), what each side gives (placement or payment), and the thread it came from. Price it with deals.update and add what goes where with deals.addPlacement.","x-scope":"deals:write","x-effect":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"projectId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"email":{"type":"string","pattern":"^[^@\\s]+@[^@\\s]+\\.[^@\\s]+$"},"title":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"oursGives":{"default":"placement","description":"What we hand over: placement or payment","type":"string","enum":["placement","payment"]},"theirsGives":{"default":"placement","description":"What they hand over: placement or payment","type":"string","enum":["placement","payment"]},"notes":{"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}]},"thread":{"anyOf":[{"type":"object","properties":{"conversationId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"topicKey":{"type":"string","minLength":1}},"required":["conversationId","topicKey"]},{"type":"null"}]}},"required":["projectId","email"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/deals/{dealId}":{"get":{"operationId":"deals.get","summary":"One deal: its terms, payment details, every placement with what the daily check last saw, the threads it came from (conversationId and topicKey, for threads.get), and its history.","x-scope":"read","x-effect":"read","parameters":[{"name":"dealId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"title":{"anyOf":[{"type":"string"},{"type":"null"}]},"state":{"type":"string","description":"agreed, partly_live, live, broken or archived. An open set."},"projectId":{"type":"string"},"project":{"type":"string"},"publisherDomain":{"anyOf":[{"type":"string"},{"type":"null"}]},"contactId":{"anyOf":[{"type":"string"},{"type":"null"}]},"who":{"anyOf":[{"type":"string"},{"type":"null"}]},"contactEmail":{"anyOf":[{"type":"string"},{"type":"null"}]},"oursGives":{"type":"string"},"theirsGives":{"type":"string"},"oursAmountCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"theirsAmountCents":{"anyOf":[{"type":"number"},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"oursInvoiceRef":{"anyOf":[{"type":"string"},{"type":"null"}]},"oursPaymentTerms":{"anyOf":[{"type":"string"},{"type":"null"}]},"oursAmountExcludesTax":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"oursPaidAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"owed":{"type":"boolean"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"archivedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"},"updatedAt":{"type":"string"},"placements":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"side":{"type":"string","description":"ours: on our page; theirs: on theirs"},"kind":{"type":"string","description":"link_insertion or added_text"},"hostUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"targetUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"anchor":{"anyOf":[{"type":"string"},{"type":"null"}]},"rel":{"anyOf":[{"type":"string"},{"type":"null"}]},"body":{"anyOf":[{"type":"string"},{"type":"null"}]},"bodyFormat":{"anyOf":[{"type":"string"},{"type":"null"}]},"position":{"anyOf":[{"type":"number"},{"type":"null"}]},"textBy":{"anyOf":[{"type":"string"},{"type":"null"}]},"status":{"type":"string","description":"agreed, live or removed"},"promisedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"publishedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"verifiedAt":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"When a check last saw it as agreed"},"checkedAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"missingSince":{"anyOf":[{"type":"string"},{"type":"null"}]},"mismatchSince":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]},"createdAt":{"type":"string"}},"required":["id","side","kind","hostUrl","targetUrl","anchor","rel","body","bodyFormat","position","textBy","status","promisedAt","publishedAt","verifiedAt","checkedAt","missingSince","mismatchSince","notes","createdAt"],"additionalProperties":false}},"threads":{"type":"array","items":{"type":"object","properties":{"conversationId":{"type":"string"},"topicKey":{"type":"string"},"title":{"type":"string"},"at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["conversationId","topicKey","title","at"],"additionalProperties":false}},"history":{"type":"array","items":{"type":"object","properties":{"type":{"type":"string"},"body":{"anyOf":[{"type":"string"},{"type":"null"}]},"actor":{"anyOf":[{"type":"string"},{"type":"null"}]},"at":{"type":"string"}},"required":["type","body","actor","at"],"additionalProperties":false}}},"required":["id","title","state","projectId","project","publisherDomain","contactId","who","contactEmail","oursGives","theirsGives","oursAmountCents","theirsAmountCents","currency","oursInvoiceRef","oursPaymentTerms","oursAmountExcludesTax","oursPaidAt","owed","notes","archivedAt","createdAt","updatedAt","placements","threads","history"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}},"patch":{"operationId":"deals.update","summary":"Change a deal's terms: what each side gives and pays (cents, with currency), invoice and payment details, and mark it paid (oursPaidAt) or not (null). Only the fields sent change. Placements have their own operations.","x-scope":"deals:write","x-effect":"write","parameters":[{"name":"dealId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"title":{"anyOf":[{"type":"string","maxLength":300},{"type":"null"}]},"publisherDomain":{"anyOf":[{"type":"string","maxLength":253},{"type":"null"}]},"contactId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"oursGives":{"type":"string","enum":["placement","payment"]},"theirsGives":{"type":"string","enum":["placement","payment"]},"oursAmountCents":{"description":"What we pay, in cents","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"theirsAmountCents":{"description":"What they pay, in cents","anyOf":[{"type":"integer","minimum":0,"maximum":9007199254740991},{"type":"null"}]},"currency":{"anyOf":[{"type":"string","pattern":"^[A-Za-z]{3}$"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}]},"oursInvoiceRef":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"oursPaymentMethod":{"anyOf":[{"type":"string","maxLength":200},{"type":"null"}]},"oursPaymentTerms":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"oursAmountExcludesTax":{"anyOf":[{"type":"boolean"},{"type":"null"}]},"oursPaidAt":{"description":"When we paid them; null to mark not paid","anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"oursInvoiceAttachmentId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":[]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/deals/{dealId}/archive":{"post":{"operationId":"deals.archive","summary":"Archive a deal (no longer tracked or checked) or reopen it.","x-scope":"deals:write","x-effect":"write","parameters":[{"name":"dealId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"archived":{"type":"boolean"}},"required":["archived"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"archived":{"type":"boolean"}},"required":["id","archived"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/deals/{dealId}/placements":{"post":{"operationId":"deals.addPlacement","summary":"Add what goes where to a deal: a link on a page (ours: on our site; theirs: on theirs), its anchor, rel and position, or added words. Marked agreed until it is live. GEOboom checks live placements daily.","x-scope":"deals:write","x-effect":"write","parameters":[{"name":"dealId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"side":{"type":"string","enum":["ours","theirs"],"description":"ours: we place them on our page; theirs: they place us on theirs"},"kind":{"default":"link_insertion","type":"string","enum":["link_insertion","added_text"],"description":"link_insertion: a link into existing words; added_text: new words with links"},"hostUrl":{"description":"The page it goes on","anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"targetUrl":{"description":"Where the link points","anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"anchor":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"rel":{"description":"e.g. nofollow, sponsored; empty for a followed link","anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"body":{"description":"The agreed words, for added_text","anyOf":[{"type":"string","maxLength":50000},{"type":"null"}]},"bodyFormat":{"description":"markdown keeps the links inside the words","anyOf":[{"type":"string","enum":["text","markdown"]},{"type":"null"}]},"position":{"description":"Our place in a listicle","anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"textBy":{"description":"Who writes the words","anyOf":[{"type":"string","enum":["us","them"]},{"type":"null"}]},"status":{"default":"agreed","type":"string","enum":["agreed","live","removed"],"description":"agreed: settled, not up yet; live: on the page; removed: was up, is not"},"promisedAt":{"description":"The date it was promised for, YYYY-MM-DD","anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}]}},"required":["side"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"}},"required":["id"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/drafts":{"get":{"operationId":"drafts.list","summary":"Messages waiting to be sent, newest first (at most 200). A `cold` draft is a first email: send it with drafts.sendFirstContact from a mailbox; any other with drafts.send.","x-scope":"read","x-effect":"read","parameters":[{"name":"projectId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"campaignId","in":"query","required":false,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"messageId":{"type":"string"},"cold":{"type":"boolean"},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"bodyText":{"anyOf":[{"type":"string"},{"type":"null"}]},"to":{"type":"object","properties":{"contactId":{"anyOf":[{"type":"string"},{"type":"null"}]},"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"email":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["contactId","name","email"],"additionalProperties":false},"targetUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The page it pitches"},"conversationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"topicKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"scheduledMailboxId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The mailbox its batch chose, for a first email"},"createdAt":{"type":"string","format":"date-time"}},"required":["messageId","cold","subject","bodyText","to","targetUrl","conversationId","topicKey","scheduledMailboxId","createdAt"],"additionalProperties":false}}},"required":["rows"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/drafts/{messageId}":{"patch":{"operationId":"drafts.update","summary":"Edit a waiting draft: subject, body, its follow-ups, and who it goes to. Fields left out stay as they are.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"messageId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"subject":{"type":"string","maxLength":500},"bodyText":{"type":"string","maxLength":50000},"followUps":{"maxItems":10,"type":"array","items":{"type":"object","properties":{"text":{"type":"string","maxLength":50000},"delayDays":{"anyOf":[{"anyOf":[{"type":"string"},{"type":"number"}]},{"type":"null"}]},"subject":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]}},"required":["text","delayDays","subject"]}},"to":{"maxItems":20,"type":"array","items":{"type":"string","maxLength":320}}},"required":[]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"messageId":{"type":"string"}},"required":["messageId"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/drafts/{messageId}/discard":{"post":{"operationId":"drafts.discard","summary":"Discard a waiting draft without sending it. It stays on the URL page; the queue moves on.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"messageId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"messageId":{"type":"string"}},"required":["messageId"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/drafts/{messageId}/first-contact":{"get":{"operationId":"drafts.previewFirstContact","summary":"What a cold draft would look like sent as a first email from a mailbox — exactly the text, the follow-ups — and anything that would stop it (suppression, a bad address, a mailbox not ready).","x-scope":"read","x-effect":"read","parameters":[{"name":"messageId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"inboxId","in":"query","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"ok":{"type":"boolean","description":"Whether it can go: no blockers"},"blockers":{"type":"array","items":{"type":"string"},"description":"What would stop it"},"warnings":{"type":"array","items":{"type":"string"},"description":"Worth reading before sending, not fatal"},"from":{"anyOf":[{"type":"object","properties":{"handle":{"type":"string"},"senderName":{"anyOf":[{"type":"string"},{"type":"null"}]},"senderTitle":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["handle","senderName","senderTitle"],"additionalProperties":false},{"type":"null"}]},"to":{"anyOf":[{"type":"string"},{"type":"null"}]},"subject":{"type":"string"},"body":{"type":"string","description":"Exactly what will be sent, signature and footer included"},"followUps":{"type":"array","items":{"type":"object","properties":{"text":{"type":"string"},"delayDays":{"anyOf":[{"type":"number"},{"type":"null"}]},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["text","delayDays","subject"],"additionalProperties":false}},"followUpDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"The organisation's days between emails, where a follow-up does not say"}},"required":["ok","blockers","warnings","from","to","subject","body","followUps","followUpDays"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}},"post":{"operationId":"drafts.sendFirstContact","summary":"Send a cold draft as a first email from a mailbox, with its follow-ups. Queued: the mailbox's schedule decides when it leaves. Refused if anything in drafts.previewFirstContact would stop it.","x-scope":"mail:send","x-effect":"outward","parameters":[{"name":"messageId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":8,"maxLength":255,"description":"Made once per intended action (a UUID) and sent unchanged on every retry of it. A retry gets the first call's answer, with `Idempotent-Replayed: true`, instead of acting twice. Kept for 7 days."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"inboxId":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"required":["inboxId"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"queued":{"type":"boolean","const":true},"to":{"type":"string"},"from":{"type":"string"},"followUpDays":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["queued","to","from","followUpDays"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/drafts/{messageId}/send":{"post":{"operationId":"drafts.send","summary":"Send a waiting draft into its thread. A cold draft (a first email) is refused: use drafts.sendFirstContact. A draft that costs credits answers `confirm` with the cost first; call again with costConfirmed to send it.","x-scope":"mail:send","x-effect":"outward","parameters":[{"name":"messageId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":8,"maxLength":255,"description":"Made once per intended action (a UUID) and sent unchanged on every retry of it. A retry gets the first call's answer, with `Idempotent-Replayed: true`, instead of acting twice. Kept for 7 days."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"costConfirmed":{"default":false,"type":"boolean"}},"required":[]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","oneOf":[{"type":"object","properties":{"status":{"type":"string","const":"confirm"},"cost":{"type":"string","description":"What it costs, in words"}},"required":["status","cost"],"additionalProperties":false},{"type":"object","properties":{"status":{"type":"string","const":"sent"},"messageId":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["status","messageId"],"additionalProperties":false}]}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/jobs/{jobId}":{"get":{"operationId":"jobs.get","summary":"Where a piece of queued work is: queued, running, done or failed. Operations that start long work (prospecting.run) return its jobId. A failed job is not retried further; what it produced, if anything, is read from the operation that started it.","x-scope":"read","x-effect":"read","parameters":[{"name":"jobId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"type":{"type":"string"},"state":{"type":"string","description":"queued, running, done or failed. An open set."},"attempts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"createdAt":{"type":"string"}},"required":["id","type","state","attempts","createdAt"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/org":{"get":{"operationId":"org.get","summary":"This organisation: name, whether it is activated, its default writing language, its credits (balance, reserved by scheduled outreach, available) and whether sending is paused for billing, and how many mailboxes it sends from.","x-scope":"read","x-effect":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"slug":{"type":"string"},"activated":{"type":"boolean","description":"False while it waits for its mailboxes; nothing can be scheduled"},"defaultLanguage":{"type":"string"},"credits":{"type":"object","properties":{"balance":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reserved":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Held by publishers already scheduled"},"available":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["balance","reserved","available"],"additionalProperties":false,"description":"In hundredths of a credit; a credit is a dollar. Each publisher scheduled costs 50."},"paused":{"anyOf":[{"type":"object","properties":{"reason":{"type":"string","description":"An open set"},"text":{"type":"string"}},"required":["reason","text"],"additionalProperties":false},{"type":"null"}],"description":"Sending is paused for billing, and why; an owner settles it in the app"},"mailboxes":{"type":"object","properties":{"active":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"paused":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["active","paused"],"additionalProperties":false}},"required":["id","name","slug","activated","defaultLanguage","credits","paused","mailboxes"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/placements/{placementId}":{"patch":{"operationId":"deals.updatePlacement","summary":"Change a placement: its terms, or its status (agreed, live, removed). Setting a status withdraws what the daily check concluded about the old one; the next check looks again. Only the fields sent change.","x-scope":"deals:write","x-effect":"write","parameters":[{"name":"placementId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"kind":{"type":"string","enum":["link_insertion","added_text"],"description":"link_insertion: a link into existing words; added_text: new words with links"},"hostUrl":{"description":"The page it goes on","anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"targetUrl":{"description":"Where the link points","anyOf":[{"type":"string","maxLength":2000},{"type":"null"}]},"anchor":{"anyOf":[{"type":"string","maxLength":500},{"type":"null"}]},"rel":{"description":"e.g. nofollow, sponsored; empty for a followed link","anyOf":[{"type":"string","maxLength":100},{"type":"null"}]},"body":{"description":"The agreed words, for added_text","anyOf":[{"type":"string","maxLength":50000},{"type":"null"}]},"bodyFormat":{"description":"markdown keeps the links inside the words","anyOf":[{"type":"string","enum":["text","markdown"]},{"type":"null"}]},"position":{"description":"Our place in a listicle","anyOf":[{"type":"integer","minimum":1,"maximum":9007199254740991},{"type":"null"}]},"textBy":{"description":"Who writes the words","anyOf":[{"type":"string","enum":["us","them"]},{"type":"null"}]},"status":{"type":"string","enum":["agreed","live","removed"],"description":"agreed: settled, not up yet; live: on the page; removed: was up, is not"},"promisedAt":{"description":"The date it was promised for, YYYY-MM-DD","anyOf":[{"type":"string","maxLength":40},{"type":"null"}]},"notes":{"anyOf":[{"type":"string","maxLength":20000},{"type":"null"}]}},"required":[]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"dealId":{"type":"string"}},"required":["id","dealId"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/projects":{"get":{"operationId":"projects.list","summary":"List this organisation's projects — one per brand being promoted — with outreach counts: URLs, publishers written to, replies, deals, live placements, threads needing action, and this month's budget.","x-scope":"read","x-effect":"read","responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"brandName":{"anyOf":[{"type":"string"},{"type":"null"}]},"brandUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaigns":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Campaigns not archived"},"paused":{"type":"boolean","description":"Every campaign is paused, so nothing is going out"},"urls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"fitUrls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"URLs judged worth writing to"},"publishers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Publishers it can write to"},"written":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Publishers a sequence was started on"},"emails":{"type":"object","properties":{"sent":{"type":"object","properties":{"cold":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"followUps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["cold","followUps"],"additionalProperties":false},"toSend":{"type":"object","properties":{"cold":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"followUps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["cold","followUps"],"additionalProperties":false},"nextPeople":{"description":"Of the cold emails to send, those to further people at a publisher already written to","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["sent","toSend"],"additionalProperties":false},"replied":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Publishers where a person wrote back"},"deals":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"placementsLive":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"needAction":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Threads owed an answer or a chase"},"budget":{"type":"object","properties":{"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"charged":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Taken this month"},"committed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Charged plus what is reserved by rows already scheduled"}},"required":["limit","charged","committed"],"additionalProperties":false,"description":"In hundredths of a credit"},"perDay":{"type":"number","description":"First emails a day it may send, as the queue divides capacity today"}},"required":["id","name","brandName","brandUrl","campaigns","paused","urls","fitUrls","publishers","written","emails","replied","deals","placementsLive","needAction","budget","perDay"],"additionalProperties":false}},"totals":{"type":"object","properties":{"urls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"fitUrls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishers":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"written":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"replied":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"deals":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"placementsLive":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"campaigns":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["urls","fitUrls","publishers","written","replied","deals","placementsLive","campaigns"],"additionalProperties":false}},"required":["rows","totals"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}},"post":{"operationId":"projects.create","summary":"Make a project for a client brand. Every mailbox of the organisation is enabled for it; its site is crawled once. Make a campaign in it next.","x-scope":"campaigns:write","x-effect":"write","requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"name":{"type":"string","minLength":1,"maxLength":200},"brandName":{"type":"string","minLength":1,"maxLength":200},"brandUrl":{"type":"string","maxLength":2000},"brandContext":{"type":"string","maxLength":10000},"pitchType":{"default":"exchange_or_paid","type":"string","enum":["exchange","exchange_or_paid","paid"]},"clientLocation":{"type":"string","maxLength":200},"postalAddress":{"type":"string","maxLength":1000}},"required":["name","brandName"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"brandName":{"type":"string","description":"The client's brand, as pitches name it"},"brandUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"brandContext":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the brand is and does, for the letters"},"pitchType":{"type":"string","description":"What it offers publishers. Today one of exchange, exchange_or_paid, paid"},"clientLocation":{"anyOf":[{"type":"string"},{"type":"null"}]},"postalAddress":{"anyOf":[{"type":"string"},{"type":"null"}]},"creditAllowance":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Whole credits a month the project may commit; null is the default"},"mailboxes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"handle":{"type":"string"},"senderName":{"anyOf":[{"type":"string"},{"type":"null"}]},"defaultTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"enabled":{"type":"boolean","description":"Whether this project sends from it"},"senderTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The role the sender signs with for this project"}},"required":["id","handle","senderName","defaultTitle","enabled","senderTitle"],"additionalProperties":false}}},"required":["id","name","brandName","brandUrl","brandContext","pitchType","clientLocation","postalAddress","creditAllowance","mailboxes"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/projects/{projectId}":{"get":{"operationId":"projects.get","summary":"One project's facts (brand, site, pitch, location), its budget, and which mailboxes it sends from.","x-scope":"read","x-effect":"read","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"brandName":{"type":"string","description":"The client's brand, as pitches name it"},"brandUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"brandContext":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the brand is and does, for the letters"},"pitchType":{"type":"string","description":"What it offers publishers. Today one of exchange, exchange_or_paid, paid"},"clientLocation":{"anyOf":[{"type":"string"},{"type":"null"}]},"postalAddress":{"anyOf":[{"type":"string"},{"type":"null"}]},"creditAllowance":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Whole credits a month the project may commit; null is the default"},"mailboxes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"handle":{"type":"string"},"senderName":{"anyOf":[{"type":"string"},{"type":"null"}]},"defaultTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"enabled":{"type":"boolean","description":"Whether this project sends from it"},"senderTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The role the sender signs with for this project"}},"required":["id","handle","senderName","defaultTitle","enabled","senderTitle"],"additionalProperties":false}}},"required":["id","name","brandName","brandUrl","brandContext","pitchType","clientLocation","postalAddress","creditAllowance","mailboxes"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}},"patch":{"operationId":"projects.update","summary":"Change a project's facts: name, brand, site, context, pitch type, location, address. Only the fields sent change.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"name":{"type":"string","maxLength":200},"brandName":{"type":"string","maxLength":200},"brandUrl":{"type":"string","maxLength":2000},"brandContext":{"type":"string","maxLength":10000},"pitchType":{"type":"string","enum":["exchange","exchange_or_paid","paid"]},"clientLocation":{"type":"string","maxLength":200},"postalAddress":{"type":"string","maxLength":1000}},"required":[]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"brandName":{"type":"string","description":"The client's brand, as pitches name it"},"brandUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"brandContext":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What the brand is and does, for the letters"},"pitchType":{"type":"string","description":"What it offers publishers. Today one of exchange, exchange_or_paid, paid"},"clientLocation":{"anyOf":[{"type":"string"},{"type":"null"}]},"postalAddress":{"anyOf":[{"type":"string"},{"type":"null"}]},"creditAllowance":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Whole credits a month the project may commit; null is the default"},"mailboxes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"handle":{"type":"string"},"senderName":{"anyOf":[{"type":"string"},{"type":"null"}]},"defaultTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"enabled":{"type":"boolean","description":"Whether this project sends from it"},"senderTitle":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The role the sender signs with for this project"}},"required":["id","handle","senderName","defaultTitle","enabled","senderTitle"],"additionalProperties":false}}},"required":["id","name","brandName","brandUrl","brandContext","pitchType","clientLocation","postalAddress","creditAllowance","mailboxes"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/projects/{projectId}/allowance":{"post":{"operationId":"projects.setAllowance","summary":"Set the whole credits a month a project may commit to new publishers; null is the default.","x-scope":"prospecting:spend","x-effect":"write","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"credits":{"anyOf":[{"type":"number"},{"type":"null"}]}},"required":["credits"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"creditAllowance":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["creditAllowance"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/projects/{projectId}/campaigns":{"get":{"operationId":"campaigns.list","summary":"List a project's campaigns (groups of prospect URLs pitched together) with their progress: URLs, publishers, emails sent and to send, replies, deals, budget, today's sending share, and daily output for the last days.","x-scope":"read","x-effect":"read","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"kind":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What it is for: links or AI answers. An open set."},"paused":{"type":"boolean"},"budgetSpent":{"type":"boolean","description":"This month's budget is used up, so scheduling has stopped"},"archived":{"type":"boolean"},"urls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishers":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"written":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"emails":{"anyOf":[{"type":"object","properties":{"sent":{"type":"object","properties":{"cold":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"followUps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["cold","followUps"],"additionalProperties":false},"toSend":{"type":"object","properties":{"cold":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"followUps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["cold","followUps"],"additionalProperties":false},"nextPeople":{"description":"Of the cold emails to send, those to further people at a publisher already written to","type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["sent","toSend"],"additionalProperties":false},{"type":"null"}]},"replied":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"funnel":{"type":"object","properties":{"fitUrls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"withContacts":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"publishers":{"anyOf":[{"type":"object","properties":{"fit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"reachable":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"written":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"scheduled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unscheduled":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unreachable":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"heldBack":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"stuck":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["fit","reachable","written","scheduled","unscheduled","unreachable","heldBack","stuck"],"additionalProperties":false},{"type":"null"}]},"coldSent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"followUps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"bounces":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"unsubscribes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["fitUrls","withContacts","publishers","coldSent","followUps","bounces","unsubscribes"],"additionalProperties":false},"deals":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"placementsLive":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"budget":{"type":"object","properties":{"limit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"charged":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Taken this month"},"committed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Charged plus what is reserved by rows already scheduled"}},"required":["limit","charged","committed"],"additionalProperties":false,"description":"In hundredths of a credit"},"needAction":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"perDay":{"anyOf":[{"type":"number"},{"type":"null"}]},"outreach":{"type":"array","items":{"type":"object","properties":{"cold":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"followUps":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["cold","followUps"],"additionalProperties":false},"description":"Emails sent on each of `days`, same order"},"templates":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Templates it would send with now; 0 means it cannot schedule"}},"required":["id","name","kind","paused","budgetSpent","archived","urls","publishers","written","emails","replied","funnel","deals","placementsLive","budget","needAction","perDay","outreach","templates"],"additionalProperties":false}},"days":{"type":"array","items":{"type":"string"},"description":"The days `outreach` covers, oldest first"}},"required":["rows","days"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}},"post":{"operationId":"campaigns.create","summary":"Make a campaign in a project. It starts paused, with no URLs; import into it, then launch it in the app.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"name":{"default":"","type":"string","maxLength":200},"kind":{"default":"links","description":"links: placements; geo: answers in AI engines","type":"string","enum":["links","geo"]},"creditAllowance":{"description":"Whole credits a month it may commit; null is the default","anyOf":[{"type":"number"},{"type":"null"}]},"excludeCompetitors":{"description":"Leave out publishers whose own site is a competitor","type":"boolean"}},"required":[]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"id":{"type":"string"},"projectId":{"type":"string"},"name":{"type":"string"},"kind":{"type":"string","description":"What it is for. Today one of links, geo; an open set."},"paused":{"type":"boolean","description":"Nothing is sent while paused; research carries on"},"launchedAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"When it was first resumed; null if it never has been"},"archived":{"type":"boolean"},"pitch":{"type":"object","properties":{"own":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"This campaign's pitch type; null follows the project's"},"effective":{"type":"string","description":"What it offers publishers. Today one of exchange, exchange_or_paid, paid"},"project":{"type":"string"}},"required":["own","effective","project"],"additionalProperties":false},"templates":{"type":"object","properties":{"mode":{"type":"string","description":"auto: every live email template of the pitch type; manual: the chosen list"},"sendsWith":{"type":"array","items":{"type":"string"},"description":"Template ids it would send with now; empty means it cannot schedule"},"chosen":{"type":"array","items":{"type":"string"},"description":"The manual list, kept while on auto"},"automatic":{"type":"object","properties":{"pitch":{"type":"string"},"ids":{"type":"array","items":{"type":"string"}}},"required":["pitch","ids"],"additionalProperties":false}},"required":["mode","sendsWith","chosen","automatic"],"additionalProperties":false},"mailboxIds":{"type":"array","items":{"type":"string"},"description":"Mailboxes it sends from; empty means all of the project's"},"sendRules":{"type":"object","properties":{"publisherLimit":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Most people written to at one publisher"},"publisherGapDays":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Days between people at one publisher; null is the default"},"includeCatchAll":{"type":"boolean","description":"Whether addresses that cannot be verified count as reachable"},"donorPageLimit":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]}},"required":["publisherLimit","publisherGapDays","includeCatchAll","donorPageLimit"],"additionalProperties":false},"excludeCompetitors":{"type":"object","properties":{"own":{"anyOf":[{"type":"boolean"},{"type":"null"}],"description":"null follows the pitch: on for paid"},"effective":{"type":"boolean","description":"Publishers whose own site is the client's competitor are left out"}},"required":["own","effective"],"additionalProperties":false},"autoFilter":{"type":"boolean"},"autoSchedule":{"type":"boolean"},"rankBy":{"anyOf":[{"type":"object","properties":{"key":{"type":"string"},"dir":{"type":"string"}},"required":["key","dir"],"additionalProperties":false},{"type":"null"}],"description":"The column it ranks on; null is the default for its kind"},"creditAllowance":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}],"description":"Whole credits a month this campaign may commit; null is the default"}},"required":["id","projectId","name","kind","paused","launchedAt","archived","pitch","templates","mailboxIds","sendRules","excludeCompetitors","autoFilter","autoSchedule","rankBy","creditAllowance"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/projects/{projectId}/mailboxes":{"put":{"operationId":"projects.setMailboxes","summary":"Replace the set of mailboxes a project sends from, with the role each sender signs with. Mailboxes left out stop sending for this project.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"projectId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"mailboxes":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},"senderTitle":{"default":"","type":"string","maxLength":200}},"required":["id"]}}},"required":["mailboxes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"mailboxes":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["mailboxes"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/publishers":{"get":{"operationId":"publishers.list","summary":"List publishers (sites) this organisation has pages or URLs for, with their authority, people, outreach counts and terms. Filter by who is in contact, what they sell and a search on the domain; optionally narrow to one project.","x-scope":"read","x-effect":"read","parameters":[{"name":"projectId","in":"query","required":false,"schema":{"description":"Only publishers with URLs in this project","anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"description":"Matches part of the domain or the company name","anyOf":[{"type":"string"},{"type":"null"}]}},{"name":"standing","in":"query","required":false,"schema":{"default":"in_contact","description":"One of in_contact, reaching_out, all. Anything else, or nothing, means in_contact.","type":"string"}},{"name":"stance","in":"query","required":false,"schema":{"default":"any","description":"One of any, exchange, paid, both, neither, not_selling. Anything else, or nothing, means any.","type":"string"}},{"name":"kind","in":"query","required":false,"schema":{"default":"any","description":"One of any, listicle_insert, link_insert, guest_post, press_release, other. Anything else, or nothing, means any.","type":"string"}},{"name":"sort","in":"query","required":false,"schema":{"default":"dr","description":"One of recent, dr, contacts, outreach, campaign_urls, pages, mentions, competitors. Anything else, or nothing, means dr.","type":"string"}},{"name":"page","in":"query","required":false,"schema":{"default":1,"type":"integer","minimum":1,"maximum":9007199254740991}},{"name":"size","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"domain":{"type":"string"},"company":{"anyOf":[{"type":"string"},{"type":"null"}]},"logo":{"anyOf":[{"type":"string"},{"type":"null"}]},"domainRating":{"anyOf":[{"type":"number"},{"type":"null"}]},"quality":{"type":"object","properties":{"verdict":{"type":"string","description":"The judgement on the site: clear, suspect, reject, unreachable, contributors_only. An open set: tolerate values not listed in these docs."},"read":{"type":"boolean"},"tone":{"type":"string","description":"The colour the app shows it in. An open set: tolerate values not listed in these docs."},"flags":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"What was found, e.g. spam, new_domain, low_authority. An open set: tolerate values not listed in these docs."},"severity":{"type":"string","description":"How much it counts. An open set: tolerate values not listed in these docs."},"why":{"type":"string","description":"In words, with the number that caused it"}},"required":["code","severity","why"],"additionalProperties":false}},"drifted":{"type":"boolean","description":"The stored verdict and today's thresholds disagree; the stored one is used"},"components":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"scored":{"type":"boolean","description":"Whether this measure moves the verdict, or is context only"},"value":{"type":"string","description":"Already formatted for reading"},"detail":{"type":"string"},"tone":{"type":"string","description":"Its colour. An open set: tolerate values not listed in these docs."},"note":{"type":"string","description":"Why it reads as it does"}},"required":["label","scored","value","tone","note"],"additionalProperties":false}}},"required":["verdict","read","tone","flags","drifted","components"],"additionalProperties":false},"metricsAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}],"description":"When the site's measurements were bought"},"urls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"people":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"warmWho":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Somebody there who is not cold, if any"},"warmth":{"anyOf":[{"type":"string","description":"How warm that person is: introduced, forwarded, in_contact. An open set: tolerate values not listed in these docs."},{"type":"null"}]},"inContact":{"type":"boolean","description":"Somebody there has written to us"},"queued":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"held":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sent":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"skipped":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"drafted":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"minFeeCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"minFeeCurrency":{"anyOf":[{"type":"string"},{"type":"null"}]},"campaignUrls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"label":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"What kind of site it is, in a few words"},"sells":{"anyOf":[{"type":"string"},{"type":"null"}]},"siteKind":{"anyOf":[{"type":"string"},{"type":"null"}]},"pages":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"mentions":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"competitors":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"hasTerms":{"type":"boolean"},"stance":{"anyOf":[{"type":"string","description":"What they are open to: exchange, paid, both, neither, not_selling. An open set: tolerate values not listed in these docs."},{"type":"null"}]},"qualityBar":{"anyOf":[{"type":"string"},{"type":"null"}]},"refuses":{"anyOf":[{"type":"string"},{"type":"null"}]},"offers":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","description":"Offer kind. An open set: tolerate values not listed in these docs."},"from":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["kind","from","currency"],"additionalProperties":false}},"hasNotes":{"type":"boolean"},"doNotApproach":{"type":"boolean"},"lastAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"projects":{"type":"array","items":{"type":"string"}}},"required":["domain","company","logo","domainRating","quality","metricsAt","urls","people","warmWho","warmth","inContact","queued","held","sent","skipped","drafted","minFeeCents","minFeeCurrency","campaignUrls","label","sells","siteKind","pages","mentions","competitors","hasTerms","stance","qualityBar","refuses","offers","hasNotes","doNotApproach","lastAt","projects"],"additionalProperties":false}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"How many match, across every page"},"applied":{"type":"object","properties":{"projectId":{"anyOf":[{"type":"string"},{"type":"null"}]},"q":{"anyOf":[{"type":"string"},{"type":"null"}]},"standing":{"type":"string"},"stance":{"type":"string"},"kind":{"type":"string"},"sort":{"type":"string"},"page":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"size":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["standing","stance","kind","sort","page","size"],"additionalProperties":false,"description":"The filters as applied, defaults included: an unknown value is replaced, not obeyed"}},"required":["rows","total","applied"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/publishers/{domain}":{"get":{"operationId":"publishers.get","summary":"Everything known about one publisher, by its site's domain: authority and traffic, the quality verdict, what they sell and their stated terms, private notes, the people there, pages and URLs held on the site, recent messages, and outreach standing.","x-scope":"read","x-effect":"read","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":253}},{"name":"projectId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"domain":{"type":"string"},"company":{"anyOf":[{"type":"string"},{"type":"null"}]},"logo":{"anyOf":[{"type":"string"},{"type":"null"}]},"domainRating":{"anyOf":[{"type":"number"},{"type":"null"}]},"quality":{"anyOf":[{"type":"object","properties":{"verdict":{"type":"string","description":"The judgement on the site: clear, suspect, reject, unreachable, contributors_only. An open set: tolerate values not listed in these docs."},"read":{"type":"boolean"},"tone":{"type":"string","description":"The colour the app shows it in. An open set: tolerate values not listed in these docs."},"flags":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","description":"What was found, e.g. spam, new_domain, low_authority. An open set: tolerate values not listed in these docs."},"severity":{"type":"string","description":"How much it counts. An open set: tolerate values not listed in these docs."},"why":{"type":"string","description":"In words, with the number that caused it"}},"required":["code","severity","why"],"additionalProperties":false}},"drifted":{"type":"boolean","description":"The stored verdict and today's thresholds disagree; the stored one is used"},"components":{"type":"array","items":{"type":"object","properties":{"label":{"type":"string"},"scored":{"type":"boolean","description":"Whether this measure moves the verdict, or is context only"},"value":{"type":"string","description":"Already formatted for reading"},"detail":{"type":"string"},"tone":{"type":"string","description":"Its colour. An open set: tolerate values not listed in these docs."},"note":{"type":"string","description":"Why it reads as it does"}},"required":["label","scored","value","tone","note"],"additionalProperties":false}}},"required":["verdict","read","tone","flags","drifted","components"],"additionalProperties":false},{"type":"null"}]},"metricsAt":{"anyOf":[{"type":"string","format":"date-time"},{"type":"null"}]},"label":{"anyOf":[{"type":"string"},{"type":"null"}]},"sells":{"anyOf":[{"type":"string"},{"type":"null"}]},"siteKind":{"anyOf":[{"type":"string"},{"type":"null"}]},"publisher":{"anyOf":[{"type":"object","properties":{"terms":{"anyOf":[{"type":"string"},{"type":"null"}]},"minFeeCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"minFeeCurrency":{"anyOf":[{"type":"string"},{"type":"null"}]},"stance":{"anyOf":[{"type":"string","description":"What they are open to. An open set: tolerate values not listed in these docs."},{"type":"null"}]},"stanceQuote":{"anyOf":[{"type":"string"},{"type":"null"}]},"qualityBar":{"anyOf":[{"type":"string"},{"type":"null"}]},"refuses":{"anyOf":[{"type":"string"},{"type":"null"}]},"offers":{"type":"array","items":{"type":"object","properties":{"kind":{"type":"string","description":"Offer kind: listicle_insert, link_insert, guest_post, press_release, other. An open set: tolerate values not listed in these docs."},"what":{"type":"string"},"minPriceCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"maxPriceCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]},"per":{"anyOf":[{"type":"string"},{"type":"null"}]},"duration":{"anyOf":[{"type":"string"},{"type":"null"}]},"conditions":{"anyOf":[{"type":"string"},{"type":"null"}]},"quote":{"type":"string","description":"Their words"},"site":{"type":"string","description":"Another of their sites this applies to, or empty"}},"required":["kind","what","minPriceCents","maxPriceCents","currency","per","duration","conditions","quote","site"],"additionalProperties":false}},"paymentMethods":{"anyOf":[{"type":"string"},{"type":"null"}]},"notes":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"This organisation's private notes"},"doNotApproach":{"type":"boolean"},"linkedinUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"xUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"company":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"slogan":{"anyOf":[{"type":"string"},{"type":"null"}]},"about":{"anyOf":[{"type":"string"},{"type":"null"}]},"size":{"anyOf":[{"type":"string"},{"type":"null"}]},"headquarters":{"anyOf":[{"type":"string"},{"type":"null"}]},"founded":{"anyOf":[{"type":"number"},{"type":"null"}]},"industries":{"anyOf":[{"type":"string"},{"type":"null"}]},"followers":{"anyOf":[{"type":"number"},{"type":"null"}]},"staff":{"anyOf":[{"type":"number"},{"type":"null"}]},"specialties":{"anyOf":[{"type":"string"},{"type":"null"}]},"website":{"anyOf":[{"type":"string"},{"type":"null"}]},"organizationType":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["name","slogan","about","size","headquarters","founded","industries","followers","staff","specialties","website","organizationType"],"additionalProperties":false},{"type":"null"}]},"companyReadAt":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["terms","minFeeCents","minFeeCurrency","stance","stanceQuote","qualityBar","refuses","offers","paymentMethods","notes","doNotApproach","linkedinUrl","xUrl","company","companyReadAt"],"additionalProperties":false},{"type":"null"}],"description":"Null when we hold pages on their site but have recorded nothing about them"},"standing":{"type":"object","properties":{"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Approaches in the last 30 days"},"lastAt":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastUrl":{"anyOf":[{"type":"string"},{"type":"null"}]},"lastWho":{"anyOf":[{"type":"string"},{"type":"null"}]},"replied":{"type":"boolean"},"repliedWho":{"anyOf":[{"type":"string"},{"type":"null"}]},"warmestWho":{"anyOf":[{"type":"string"},{"type":"null"}]},"warmestWarmth":{"anyOf":[{"type":"string","description":"introduced, forwarded, in_contact. An open set: tolerate values not listed in these docs."},{"type":"null"}]},"bounced":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["count","lastAt","lastUrl","lastWho","replied","repliedWho","warmestWho","warmestWarmth","bounced"],"additionalProperties":false},"pages":{"type":"array","items":{"type":"object","properties":{"targetId":{"type":"string"},"url":{"type":"string"},"status":{"type":"string","description":"The URL's status. An open set: tolerate values not listed in these docs."},"project":{"type":"string"},"projectId":{"type":"string"},"campaignId":{"anyOf":[{"type":"string"},{"type":"null"}]},"queueStatus":{"anyOf":[{"type":"string","description":"Where its pitch is in the queue. An open set: tolerate values not listed in these docs."},{"type":"null"}]},"holdReason":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["targetId","url","status","project","projectId","campaignId","queueStatus","holdReason"],"additionalProperties":false}},"people":{"type":"array","items":{"type":"object","properties":{"contactId":{"type":"string"},"who":{"type":"string"},"email":{"anyOf":[{"type":"string"},{"type":"null"}]},"emailStatus":{"type":"string","description":"Whether the address is verified. An open set: tolerate values not listed in these docs."},"jobTitle":{"anyOf":[{"type":"string"},{"type":"null"}]},"warmth":{"anyOf":[{"type":"string","description":"introduced, forwarded, in_contact. An open set: tolerate values not listed in these docs."},{"type":"null"}]},"warmReason":{"anyOf":[{"type":"string"},{"type":"null"}]},"wroteAPage":{"type":"boolean"},"urls":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["contactId","who","email","emailStatus","jobTitle","warmth","warmReason","wroteAPage","urls"],"additionalProperties":false}},"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"direction":{"type":"string","description":"inbound or outbound. An open set: tolerate values not listed in these docs."},"status":{"type":"string","description":"The message's status. An open set: tolerate values not listed in these docs."},"from":{"anyOf":[{"type":"string"},{"type":"null"}]},"to":{"type":"array","items":{"type":"string"}},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"at":{"type":"string"},"contactId":{"anyOf":[{"type":"string"},{"type":"null"}]},"conversationId":{"anyOf":[{"type":"string"},{"type":"null"}]},"topicKey":{"anyOf":[{"type":"string"},{"type":"null"}]},"projectId":{"anyOf":[{"type":"string"},{"type":"null"}]},"projectName":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","direction","status","from","to","subject","at","contactId","conversationId","topicKey","projectId","projectName"],"additionalProperties":false}}},"required":["domain","company","logo","domainRating","quality","metricsAt","label","sells","siteKind","publisher","standing","pages","people","messages"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/publishers/{domain}/do-not-approach":{"post":{"operationId":"publishers.setApproachable","summary":"Mark a publisher do-not-approach, or allow approaches again. Marking drops every pitch still queued for their site and withdraws sequences already handed to the mail provider, so no follow-up goes out; un-marking puts the dropped pitches back in the queue but does not re-add withdrawn sequences.","x-scope":"campaigns:write","x-effect":"outward","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":253}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":8,"maxLength":255,"description":"Made once per intended action (a UUID) and sent unchanged on every retry of it. A retry gets the first call's answer, with `Idempotent-Replayed: true`, instead of acting twice. Kept for 7 days."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"doNotApproach":{"type":"boolean"}},"required":["doNotApproach"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"domain":{"type":"string"},"doNotApproach":{"type":"boolean"},"queueChanged":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"withdrawn":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["domain","doNotApproach","queueChanged","withdrawn"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/publishers/{domain}/notes":{"post":{"operationId":"publishers.saveNotes","summary":"Replace this organisation's private notes on a publisher (their site's domain). Empty text clears them. Notes are never shown to the publisher.","x-scope":"campaigns:write","x-effect":"write","parameters":[{"name":"domain","in":"path","required":true,"schema":{"type":"string","minLength":1,"maxLength":253}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"notes":{"type":"string"}},"required":["notes"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"domain":{"type":"string"},"notes":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["domain","notes"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/threads":{"get":{"operationId":"threads.list","summary":"List inbox threads with publishers, newest first: who each is with, whether it is owed an answer (need_action) or a chase, the page pitched, where a deal stands, and the suggested next step. Also returns how many threads are behind each tab. Filter by tab, project, campaign, contact, or a search.","x-scope":"read","x-effect":"read","parameters":[{"name":"tab","in":"query","required":false,"schema":{"default":"all","description":"One of all, need_action, replied, sending, client, inbound. Anything else, or nothing, means all.","type":"string"}},{"name":"projectId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},{"name":"campaignId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},{"name":"contactId","in":"query","required":false,"schema":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},{"name":"q","in":"query","required":false,"schema":{"description":"Matches names, addresses, company, the pitched page's domain or URL, and the subject","anyOf":[{"type":"string"},{"type":"null"}]}},{"name":"page","in":"query","required":false,"schema":{"default":1,"type":"integer","minimum":1,"maximum":9007199254740991}},{"name":"size","in":"query","required":false,"schema":{"default":50,"type":"integer","minimum":1,"maximum":100}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"rows":{"type":"array","items":{"type":"object","properties":{"conversationId":{"type":"string"},"topicKey":{"type":"string","description":"With conversationId, names the thread"},"channel":{"type":"string","description":"email, linkedin. An open set: tolerate values not listed here."},"contactId":{"type":"string","description":"Whose conversation it is"},"who":{"type":"string","description":"Who the newest message is with"},"whoId":{"type":"string"},"whoEmail":{"anyOf":[{"type":"string"},{"type":"null"}]},"inboxHandle":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our mailbox the thread is on"},"title":{"type":"string"},"lastDirection":{"anyOf":[{"type":"string","description":"inbound or outbound. An open set: tolerate values not listed here."},{"type":"null"}]},"preview":{"type":"string","description":"The start of the newest message"},"awaiting":{"type":"boolean","description":"A person wrote last and nobody has answered"},"awaitingFrom":{"anyOf":[{"type":"string"},{"type":"null"}]},"followUp":{"type":"boolean","description":"We wrote last and are owed an answer worth chasing"},"unread":{"type":"boolean"},"autoReply":{"type":"boolean"},"sending":{"type":"boolean","description":"A message is queued to go"},"snoozedUntil":{"anyOf":[{"type":"string"},{"type":"null"}]},"awayUntil":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"They said they are away until"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"agreement":{"anyOf":[{"type":"string","description":"Where a deal stands on the thread, as read from it. An open set: tolerate values not listed here."},{"type":"null"}]},"stage":{"anyOf":[{"type":"string","description":"The thread's stage. An open set: tolerate values not listed here."},{"type":"null"}]},"next":{"anyOf":[{"type":"object","properties":{"verb":{"type":"string","description":"What to do next. An open set: tolerate values not listed here."},"what":{"type":"string"}},"required":["verb","what"],"additionalProperties":false},{"type":"null"}]},"deal":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"state":{"type":"string","description":"The deal's state. An open set: tolerate values not listed here."},"live":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"placements":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"oursGives":{"type":"string"},"theirsGives":{"type":"string"},"oursCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"theirsCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","state","live","placements","count","oursGives","theirsGives","oursCents","theirsCents","currency"],"additionalProperties":false},{"type":"null"}]},"targetUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The page we pitched"},"targetId":{"anyOf":[{"type":"string"},{"type":"null"}]},"projectId":{"anyOf":[{"type":"string"},{"type":"null"}]},"projectName":{"anyOf":[{"type":"string"},{"type":"null"}]},"domainRating":{"anyOf":[{"type":"number"},{"type":"null"}]},"publisherBlocked":{"type":"boolean","description":"The publisher is marked do-not-approach"},"minFeeCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"minFeeCurrency":{"anyOf":[{"type":"string"},{"type":"null"}]},"stance":{"anyOf":[{"type":"string","description":"What they are open to. An open set: tolerate values not listed here."},{"type":"null"}]},"at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["conversationId","topicKey","channel","contactId","who","whoId","whoEmail","inboxHandle","title","lastDirection","preview","awaiting","awaitingFrom","followUp","unread","autoReply","sending","snoozedUntil","awayUntil","labels","agreement","stage","next","deal","targetUrl","targetId","projectId","projectName","domainRating","publisherBlocked","minFeeCents","minFeeCurrency","stance","at"],"additionalProperties":false}},"total":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"counts":{"type":"object","properties":{"all":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"needAction":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991,"description":"Owed an answer or a chase"},"replied":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"sending":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"dealAgreed":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"negotiating":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991}},"required":["all","needAction","replied","sending","dealAgreed","negotiating"],"additionalProperties":false,"description":"Threads behind each tab, with this call's other filters"}},"required":["rows","total","counts"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/threads/{conversationId}":{"get":{"operationId":"threads.get","summary":"One inbox thread and all its messages, oldest first, with sender, recipients, subject, plain text, and whether each was an automatic reply. Names the thread by conversationId and topicKey, as threads.list returns them.","x-scope":"read","x-effect":"read","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"topicKey","in":"query","required":true,"schema":{"type":"string","minLength":1,"description":"As threads.list returns it; URL-encode it"}}],"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"thread":{"type":"object","properties":{"conversationId":{"type":"string"},"topicKey":{"type":"string","description":"With conversationId, names the thread"},"channel":{"type":"string","description":"email, linkedin. An open set: tolerate values not listed here."},"contactId":{"type":"string","description":"Whose conversation it is"},"who":{"type":"string","description":"Who the newest message is with"},"whoId":{"type":"string"},"whoEmail":{"anyOf":[{"type":"string"},{"type":"null"}]},"inboxHandle":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"Our mailbox the thread is on"},"title":{"type":"string"},"lastDirection":{"anyOf":[{"type":"string","description":"inbound or outbound. An open set: tolerate values not listed here."},{"type":"null"}]},"preview":{"type":"string","description":"The start of the newest message"},"awaiting":{"type":"boolean","description":"A person wrote last and nobody has answered"},"awaitingFrom":{"anyOf":[{"type":"string"},{"type":"null"}]},"followUp":{"type":"boolean","description":"We wrote last and are owed an answer worth chasing"},"unread":{"type":"boolean"},"autoReply":{"type":"boolean"},"sending":{"type":"boolean","description":"A message is queued to go"},"snoozedUntil":{"anyOf":[{"type":"string"},{"type":"null"}]},"awayUntil":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"They said they are away until"},"labels":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"}},"required":["id","name"],"additionalProperties":false}},"agreement":{"anyOf":[{"type":"string","description":"Where a deal stands on the thread, as read from it. An open set: tolerate values not listed here."},{"type":"null"}]},"stage":{"anyOf":[{"type":"string","description":"The thread's stage. An open set: tolerate values not listed here."},{"type":"null"}]},"next":{"anyOf":[{"type":"object","properties":{"verb":{"type":"string","description":"What to do next. An open set: tolerate values not listed here."},"what":{"type":"string"}},"required":["verb","what"],"additionalProperties":false},{"type":"null"}]},"deal":{"anyOf":[{"type":"object","properties":{"id":{"type":"string"},"state":{"type":"string","description":"The deal's state. An open set: tolerate values not listed here."},"live":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"placements":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"count":{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},"oursGives":{"type":"string"},"theirsGives":{"type":"string"},"oursCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"theirsCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"currency":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["id","state","live","placements","count","oursGives","theirsGives","oursCents","theirsCents","currency"],"additionalProperties":false},{"type":"null"}]},"targetUrl":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The page we pitched"},"targetId":{"anyOf":[{"type":"string"},{"type":"null"}]},"projectId":{"anyOf":[{"type":"string"},{"type":"null"}]},"projectName":{"anyOf":[{"type":"string"},{"type":"null"}]},"domainRating":{"anyOf":[{"type":"number"},{"type":"null"}]},"publisherBlocked":{"type":"boolean","description":"The publisher is marked do-not-approach"},"minFeeCents":{"anyOf":[{"type":"integer","minimum":-9007199254740991,"maximum":9007199254740991},{"type":"null"}]},"minFeeCurrency":{"anyOf":[{"type":"string"},{"type":"null"}]},"stance":{"anyOf":[{"type":"string","description":"What they are open to. An open set: tolerate values not listed here."},{"type":"null"}]},"at":{"anyOf":[{"type":"string"},{"type":"null"}]}},"required":["conversationId","topicKey","channel","contactId","who","whoId","whoEmail","inboxHandle","title","lastDirection","preview","awaiting","awaitingFrom","followUp","unread","autoReply","sending","snoozedUntil","awayUntil","labels","agreement","stage","next","deal","targetUrl","targetId","projectId","projectName","domainRating","publisherBlocked","minFeeCents","minFeeCurrency","stance","at"],"additionalProperties":false},"messages":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"direction":{"type":"string","description":"inbound or outbound. An open set: tolerate values not listed here."},"status":{"type":"string","description":"The message's status. An open set: tolerate values not listed here."},"from":{"anyOf":[{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"type":"string"}},"required":["name","address"],"additionalProperties":false},{"type":"null"}]},"to":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"type":"string"}},"required":["name","address"],"additionalProperties":false}},"cc":{"type":"array","items":{"type":"object","properties":{"name":{"anyOf":[{"type":"string"},{"type":"null"}]},"address":{"type":"string"}},"required":["name","address"],"additionalProperties":false}},"subject":{"anyOf":[{"type":"string"},{"type":"null"}]},"text":{"anyOf":[{"type":"string"},{"type":"null"}]},"language":{"anyOf":[{"type":"string"},{"type":"null"}]},"autoReply":{"type":"boolean"},"at":{"type":"string","format":"date-time"}},"required":["id","direction","status","from","to","cc","subject","text","language","autoReply","at"],"additionalProperties":false}}},"required":["thread","messages"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/threads/{conversationId}/replies":{"post":{"operationId":"threads.reply","summary":"Reply on a thread. Send `seenMessageId`, the newest message you read: if a newer one has arrived the reply is refused, to be read and answered instead. Others on the thread may be included by address. An identical reply on the same thread within 24 hours is refused.","x-scope":"mail:send","x-effect":"outward","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":8,"maxLength":255,"description":"Made once per intended action (a UUID) and sent unchanged on every retry of it. A retry gets the first call's answer, with `Idempotent-Replayed: true`, instead of acting twice. Kept for 7 days."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"topicKey":{"type":"string","minLength":1},"subject":{"default":"","type":"string","maxLength":500},"bodyText":{"type":"string","maxLength":50000},"alsoInclude":{"default":[],"maxItems":50,"type":"array","items":{"type":"string","maxLength":320}},"suggestionId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"seenMessageId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]},"attachments":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}}},"required":["topicKey","bodyText"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"messageId":{"anyOf":[{"type":"string"},{"type":"null"}],"description":"The reply, once recorded; null on a client or peer thread"}},"required":["messageId"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}},"/threads/{conversationId}/topics":{"post":{"operationId":"threads.startTopic","summary":"Start a new subject with somebody already in a conversation. Refused if a thread with that subject exists: reply there instead.","x-scope":"mail:send","x-effect":"outward","parameters":[{"name":"conversationId","in":"path","required":true,"schema":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":8,"maxLength":255,"description":"Made once per intended action (a UUID) and sent unchanged on every retry of it. A retry gets the first call's answer, with `Idempotent-Replayed: true`, instead of acting twice. Kept for 7 days."}}],"requestBody":{"required":true,"content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"subject":{"type":"string","maxLength":500},"bodyText":{"type":"string","maxLength":50000},"attachments":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"}},"toAddresses":{"default":[],"maxItems":20,"type":"array","items":{"type":"string","maxLength":320}},"dealId":{"anyOf":[{"type":"string","format":"uuid","pattern":"^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$"},{"type":"null"}]}},"required":["subject","bodyText"]}}}},"responses":{"200":{"description":"OK","content":{"application/json":{"schema":{"$schema":"https://json-schema.org/draft/2020-12/schema","type":"object","properties":{"topicKey":{"type":"string"}},"required":["topicKey"],"additionalProperties":false}}}},"default":{"description":"A refusal","content":{"application/problem+json":{"schema":{"type":"object","description":"RFC 9457 problem details. `code` is stable; `detail` is for people.","properties":{"type":{"type":"string"},"title":{"type":"string"},"status":{"type":"integer"},"code":{"type":"string","description":"unauthorized, grant_paused, forbidden, invalid, not_found, conflict, in_progress, idempotency_mismatch, no_credits, not_activated, rate_limited, internal. An open set."},"detail":{"type":"string"},"requestId":{"type":"string"}},"required":["type","title","status","code"]}}}}}}}}}