Skip to content
Scouty Docs
ScoutyDocs
  • Get startedGuides
  • Control and troubleshootingGuides
  • API referenceAPI reference
  • Limits, errors, and policiesGuides

Draft a campaign's activation steps from a document

Reads a Notion page, a Google Doc or a PDF and drafts the campaign's activation steps from it, as the dashboard's Import a document tile does, and adds the document to the flow's knowledge sources. Only onto a flow with no steps yet. Each run is a paid model call, so confirmBillable must be true. pdfBase64 is at most 4,300,000 characters. Nothing is published.

POST/v1/campaigns/{campaignId}/activation/import
  • Scopecampaigns:write
  • Write
  • Safe to retry
  • MCP toolscouty_import_activation_document

Markdown version for your agent

Authorization

Send a Scouty token as a bearer token in the Authorization header. The token needs the campaigns:write scope, or the call answers 403 insufficient_scope. Tokens and scopes

Authorization: Bearer $SCOUTY_TOKEN

Path parameters

NameTypeRequiredDescription
campaignIdintegerRequired

The campaign whose activation flow this is about.

Headers

NameTypeRequiredDescription
Idempotency-KeystringOptional

The same key the body's idempotencyKey carries. Send one or the other, or both with the same value.

Body parameters

A JSON object, sent with Content-Type: application/json.

NameTypeRequiredDescription
idempotencyKeystringRequired

A key you choose for this call, 8 to 128 characters of letters, digits, dot, underscore, colon or hyphen. Sending the same key with the same arguments replays the first answer and changes nothing, so a retry after a timeout is safe.

referencestringOptional

A Notion page or Google Docs link to read the steps from.

pdfBase64stringOptional

Or a PDF to read the steps from, as standard base64 with no data: prefix.

labelstringOptional

What to call the document on the knowledge list. Named the way the dashboard names it when left out.

confirmBillablebooleanRequired

Must be true. Reading a document into steps is a paid model call on every run.

Errors

A refusal answers { "error": { "code", "message" } }. Branch on code; the message is for a person. Every error and its fix

Statuserror.codeMeaning
400 Bad Requestinvalid_requestThe request was not the shape this capability takes, or its body was not JSON.
401 Unauthorizedmissing_token invalid_token token_revoked token_expired token_orphanedNo token, or one that is not recognized, revoked or expired.
403 Forbiddeninsufficient_scope wrong_principalThe token does not carry the scope this capability needs.
404 Not Foundnot_foundNo such route, or no such campaign for this client.
409 Conflictidempotency_conflictThat idempotency key was already used for a different request. Nothing was changed.
429 Too Many Requestsrate_limitedToo many requests this minute. Retry-After says how long is left.