v1

latestOpenAPI 3.1.02026-07-26194149.1 KB

Scouting

Update Email Settings

Update email notification settings and manage subscribers for a scout.

put/v1/scouting/tasks/{scout_id}/email-settings

Path parameters

scout_idstring uuid required

Request body

skip_emailboolean nullable

    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_addstring[] nullable

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

subscribers_to_removestring[] nullable

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

Response

Successful Response

scout_idstring required

The ID of the scout

skip_emailboolean nullable

Current skip_email setting, if updated

messagestring required

Summary of changes made