Update Email Settings

PUT

scouting

tasks

{scout_id}

email-settings

curl --request PUT \
  --url https://api.yutori.com/v1/scouting/tasks/123e4567-e89b-12d3-a456-426614174000/email-settings \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "skip_email": true
  }'

import requests

response = requests.put(
    "https://api.yutori.com/v1/scouting/tasks/123e4567-e89b-12d3-a456-426614174000/email-settings",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={"skip_email": True}
)
print(response.json())

const response = await fetch(
  "https://api.yutori.com/v1/scouting/tasks/123e4567-e89b-12d3-a456-426614174000/email-settings",
  {
    method: "PUT",
    headers: {
      "X-API-Key": "YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({ skip_email: true })
  }
);
const data = await response.json();

{
  "scout_id": "<string>",
  "message": "<string>",
  "skip_email": true,
  "subscribers_added": [
    {
      "email": "<string>",
      "message": "<string>"
    }
  ],
  "subscribers_removed": [
    {
      "email": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

curl --request PUT \
  --url https://api.yutori.com/v1/scouting/tasks/123e4567-e89b-12d3-a456-426614174000/email-settings \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "skip_email": true
  }'

import requests

response = requests.put(
    "https://api.yutori.com/v1/scouting/tasks/123e4567-e89b-12d3-a456-426614174000/email-settings",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={"skip_email": True}
)
print(response.json())

const response = await fetch(
  "https://api.yutori.com/v1/scouting/tasks/123e4567-e89b-12d3-a456-426614174000/email-settings",
  {
    method: "PUT",
    headers: {
      "X-API-Key": "YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({ skip_email: true })
  }
);
const data = await response.json();

Overview

Manage email notification settings and subscriber lists for a scout. All fields are optional - provide only what you want to change.

Permissions

Scout creators: Can update all settings and manage all subscribers
Non-creators: Can only unsubscribe themselves

Use Cases

1. Toggle Email Notifications Only

Disable email notifications while keeping subscribers:

Request

curl --request PUT \
  --url https://api.yutori.com/v1/scouting/tasks/{scout_id}/email-settings \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "skip_email": true
  }'

Response

{
  "scout_id": "123e4567-e89b-12d3-a456-426614174000",
  "skip_email": true,
  "message": "Email notifications disabled"
}

2. Add Subscribers Only

Subscribe multiple emails without changing notification settings:

Request

curl --request PUT \
  --url https://api.yutori.com/v1/scouting/tasks/{scout_id}/email-settings \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "subscribers_to_add": [
      "alice@example.com",
      "bob@example.com",
      "charlie@example.com"
    ]
  }'

Response

{
  "scout_id": "123e4567-e89b-12d3-a456-426614174000",
  "subscribers_added": [
    {"email": "alice@example.com", "status": "added"},
    {"email": "bob@example.com", "status": "already_subscribed"},
    {"email": "charlie@example.com", "status": "added"}
  ],
  "message": "Added 2 subscriber(s)"
}

3. Unsubscribe Yourself (Non-creator)

If you’re not the scout creator, you can unsubscribe yourself:

Request

curl --request PUT \
  --url https://api.yutori.com/v1/scouting/tasks/{scout_id}/email-settings \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "subscribers_to_remove": ["your-email@example.com"]
  }'

Response

{
  "scout_id": "123e4567-e89b-12d3-a456-426614174000",
  "subscribers_removed": [
    {"email": "your-email@example.com", "status": "removed"}
  ],
  "message": "Removed 1 subscriber(s)"
}

4. Remove Multiple Subscribers (Creator Only)

Scout creators can remove any subscribers:

Request

curl --request PUT \
  --url https://api.yutori.com/v1/scouting/tasks/{scout_id}/email-settings \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "subscribers_to_remove": [
      "alice@example.com",
      "bob@example.com"
    ]
  }'

Response

{
  "scout_id": "123e4567-e89b-12d3-a456-426614174000",
  "subscribers_removed": [
    {"email": "alice@example.com", "status": "removed"},
    {"email": "bob@example.com", "status": "removed"}
  ],
  "message": "Removed 2 subscriber(s)"
}

5. Combined Update

Update multiple settings at once:

Request

curl --request PUT \
  --url https://api.yutori.com/v1/scouting/tasks/{scout_id}/email-settings \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "skip_email": false,
    "subscribers_to_add": ["newuser@example.com"],
    "subscribers_to_remove": ["olduser@example.com"]
  }'

Response

{
  "scout_id": "123e4567-e89b-12d3-a456-426614174000",
  "skip_email": false,
  "subscribers_added": [
    {"email": "newuser@example.com", "status": "added"}
  ],
  "subscribers_removed": [
    {"email": "olduser@example.com", "status": "removed"}
  ],
  "message": "Email notifications enabled; Added 1 subscriber(s); Removed 1 subscriber(s)"
}

Error Responses

403 Forbidden - Permission Denied

Non-creator trying to add subscribers:

{
  "detail": "Only scout creator can add subscribers"
}

Non-creator trying to remove someone else:

{
  "detail": "You can only unsubscribe yourself. Your email: your-email@example.com"
}

400 Bad Request - Validation Errors

No fields provided:

{
  "detail": "At least one field must be provided"
}

Too many emails:

{
  "detail": "Maximum 200 subscribers per request"
}

404 Not Found

{
  "detail": "Scout with id {scout_id} not found"
}

Response Field Descriptions

SubscriberResult Status Values

Status	Description
`added`	Email was successfully subscribed
`removed`	Email was successfully unsubscribed
`already_subscribed`	Email was already subscribed (not an error)
`not_found`	Email was not found in subscriber list (for removal)
`invalid`	Email format is invalid
`permission_denied`	User lacks permission to perform this operation

Notes

Email addresses are automatically normalized (lowercased and trimmed)
Duplicate emails in a single request are automatically removed
Adding an already-subscribed email returns already_subscribed status (not an error)
Removing a non-existent subscription returns not_found status (not an error)
Maximum 200 email addresses per request for subscribers_to_add
All operations are idempotent - safe to retry

Authorizations

x-api-key

string

header

required

Path Parameters

scout_id

string<uuid>

required

Body

application/json

skip_email

boolean | null

    If true, email notifications will be skipped and only webhook notifications will be sent.
    If false, both email and webhook notifications will be sent (default behavior).

subscribers_to_add

string[] | null

List of email addresses to subscribe to this scout. Maximum 200 per request. Duplicates are automatically ignored.

subscribers_to_remove

string[] | null

List of email addresses to unsubscribe from this scout. Non-creators can only remove themselves.

Response

Successful Response

scout_id

string

required

The ID of the scout

message

string

required

Summary of changes made

skip_email

boolean | null

Current skip_email setting, if updated

subscribers_added

SubscriberResult · object[] | null

Results for each email address in subscribers_to_add

Show child attributes

subscribers_removed

SubscriberResult · object[] | null

Results for each email address in subscribers_to_remove

Show child attributes

Mark Scout As DoneMark a scout as done. The scout will be archived and stop running.

curl --request PUT \
  --url https://api.yutori.com/v1/scouting/tasks/123e4567-e89b-12d3-a456-426614174000/email-settings \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
    "skip_email": true
  }'

import requests

response = requests.put(
    "https://api.yutori.com/v1/scouting/tasks/123e4567-e89b-12d3-a456-426614174000/email-settings",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={"skip_email": True}
)
print(response.json())

const response = await fetch(
  "https://api.yutori.com/v1/scouting/tasks/123e4567-e89b-12d3-a456-426614174000/email-settings",
  {
    method: "PUT",
    headers: {
      "X-API-Key": "YOUR_API_KEY",
      "Content-Type": "application/json"
    },
    body: JSON.stringify({ skip_email: true })
  }
);
const data = await response.json();

{
  "scout_id": "<string>",
  "message": "<string>",
  "skip_email": true,
  "subscribers_added": [
    {
      "email": "<string>",
      "message": "<string>"
    }
  ],
  "subscribers_removed": [
    {
      "email": "<string>",
      "message": "<string>"
    }
  ]
}

{
  "detail": [
    {
      "loc": [
        "<string>"
      ],
      "msg": "<string>",
      "type": "<string>",
      "input": "<unknown>",
      "ctx": {}
    }
  ]
}

Getting Started

General

Navigator API

Browsing API

Research API

Scouting API

Webhooks

Update Email Settings

Overview

Permissions

Use Cases

1. Toggle Email Notifications Only

2. Add Subscribers Only

3. Unsubscribe Yourself (Non-creator)

4. Remove Multiple Subscribers (Creator Only)

5. Combined Update

Error Responses

403 Forbidden - Permission Denied

400 Bad Request - Validation Errors

404 Not Found

Response Field Descriptions

SubscriberResult Status Values

Notes

Authorizations

Path Parameters

Body

Response

​Overview

​Permissions

​Use Cases

​1. Toggle Email Notifications Only

​2. Add Subscribers Only

​3. Unsubscribe Yourself (Non-creator)

​4. Remove Multiple Subscribers (Creator Only)

​5. Combined Update

​Error Responses

​403 Forbidden - Permission Denied

​400 Bad Request - Validation Errors

​404 Not Found

​Response Field Descriptions

​SubscriberResult Status Values

​Notes

Authorizations

Path Parameters

Body

Response

Overview

Permissions

Use Cases

1. Toggle Email Notifications Only

2. Add Subscribers Only

3. Unsubscribe Yourself (Non-creator)

4. Remove Multiple Subscribers (Creator Only)

5. Combined Update

Error Responses

403 Forbidden - Permission Denied

400 Bad Request - Validation Errors

404 Not Found

Response Field Descriptions

SubscriberResult Status Values

Notes