Update a campaign's example videos and reference links

Adds or removes the example videos creators are shown on one campaign, and its reference links. A video link is an https link to TikTok, Instagram or YouTube; a reference link is any https link. A campaign carries at most 6 example videos and 8 reference links. Only a draft or paused campaign takes a change, as in the dashboard. Returns both lists as the campaign now carries them.

PATCHhttps://api.tryscouty.com/v1/campaigns/{campaignId}/examples

Scopecampaigns:write
Write
MCP toolscouty_update_campaign_examples

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

Name	Type	Required	Description
`campaignId`	`integer`	Required	The campaign to change.

Headers

Name	Type	Required	Description
`Idempotency-Key`	`string`	Optional	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.

Name	Type	Required	Description
`idempotencyKey`	`string`	Required	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.
`add`	`object`	Optional
`add.videos`	`object[]`	Optional	Example videos to add after the ones the campaign has. An agent adds links; a video uploaded in Scouty chat is added from there.
`add.links`	`object[]`	Optional	Reference links to add after the ones the campaign has.
`remove`	`object`	Optional
`remove.videoIndexes`	`integer[]`	Optional	Example videos to remove, by their position in exampleVideos, counting from 0.
`remove.linkUrls`	`string[]`	Optional	Reference links to remove, by their url.

Errors

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

Status	error.code	Meaning
400 Bad Request	`invalid_request`	The request was not the shape this capability takes, or its body was not JSON.
401 Unauthorized	`missing_token` `invalid_token` `token_revoked` `token_expired` `token_orphaned`	No token, or one that is not recognized, revoked or expired.
403 Forbidden	`insufficient_scope` `wrong_principal`	The token does not carry the scope this capability needs.
404 Not Found	`not_found`	No such route, or no such campaign for this client.
409 Conflict	`idempotency_conflict`	That idempotency key was already used for a different request. Nothing was changed.
429 Too Many Requests	`rate_limited`	Too many requests this minute. Retry-After says how long is left.

curl -s -X PATCH https://api.tryscouty.com/v1/campaigns/42/examples \ -H "Authorization: Bearer $SCOUTY_TOKEN" \ -H "Content-Type: application/json" \ -d '{"idempotencyKey":"examples-42-1","add":{"videos":[{"url":"https://www.tiktok.com/@acme.example/video/1","caption":"The hook we want"}],"links":[{"url":"https://acme.example/brand-guide","label":"Brand guide"}]}}'

const response = await fetch("https://api.tryscouty.com/v1/campaigns/42/examples", { method: "PATCH", headers: { Authorization: `Bearer ${process.env.SCOUTY_TOKEN}`, "Content-Type": "application/json", }, body: JSON.stringify({ idempotencyKey: "examples-42-1", add: { videos: [ { url: "https://www.tiktok.com/@acme.example/video/1", caption: "The hook we want" } ], links: [ { url: "https://acme.example/brand-guide", label: "Brand guide" } ] } }), }); console.log(await response.json());

import os import requests token = os.environ["SCOUTY_TOKEN"] response = requests.patch( "https://api.tryscouty.com/v1/campaigns/42/examples", headers={"Authorization": f"Bearer {token}"}, json={ "idempotencyKey": "examples-42-1", "add": {"videos": [{"url": "https://www.tiktok.com/@acme.example/video/1", "caption": "The hook we want"}], "links": [{"url": "https://acme.example/brand-guide", "label": "Brand guide"}]}, }, ) print(response.json())

{ "campaignId": 42, "exampleVideos": [ { "kind": "link", "url": "https://www.tiktok.com/@acme.example/video/1", "caption": "The hook we want" } ], "referenceLinks": [ { "url": "https://acme.example/brand-guide", "label": "Brand guide" } ] }