ScoutsAdd a steering note

Add a steering note

Steer the scout with a short note, such as ignore /docs pages or Black Friday sale runs Nov 25-30. At most 500 characters and 20 active notes per scout (422 note_limit).

curl -X POST "https://mythic-analytics.gulp.workers.dev/client/v1/scouts/123e4567-e89b-12d3-a456-426614174000/notes" \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_TOKEN" \
  -d '{
  "body": "example_string",
  "expires_at": "2024-12-25T10:00:00Z"
}'
{
  "success": true,
  "data": {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "scout_id": "123e4567-e89b-12d3-a456-426614174000",
    "body": "example_string",
    "expires_at": "2024-12-25T10:00:00Z",
    "active": true,
    "source_report_id": "123e4567-e89b-12d3-a456-426614174000",
    "families": [
      "example_string"
    ],
    "created_by": "example_string",
    "created_at": "2024-12-25T10:00:00Z"
  }
}
POST
/client/v1/scouts/{id}/notes
POST
Base URLstring

Target server for requests. Edit to use your own host.

Bearer Token
Bearer Tokenstring
Required

Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need scouts:read or scouts:write, plus the read scope of every surface a scout's skill reads to create or run it, and of every surface a report's run read to open it.

Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need scouts:read or scouts:write, plus the read scope of every surface a scout's skill reads to create or run it, and of every surface a report's run read to open it.
Content-Typestring
Required

The media type of the request body

Options: application/json
bodystring
Required
Min length: 1 • Max length: 500
expires_atstring

When the note stops applying: a future time within 366 days. Null or omitted: no end.

Format: date-time
Request Preview
Response

Response will appear here after sending the request

Authentication

header
Authorizationstring
Required

Bearer token. Agency key (ak_) only; a location secret key (sk_) gets 403 agency_required. Agency-wide scoped keys (mcp_) need scouts:read or scouts:write, plus the read scope of every surface a scout's skill reads to create or run it, and of every surface a report's run read to open it.

Path Parameters

Body

application/json
expires_atstring

When the note stops applying: a future time within 366 days. Null or omitted: no end.

Responses