Change how the person is told about Offers and checks. Leave out request_id to change their account-wide settings. check_frequency: adaptive, weekly, monthly or never. check_channels: agent_then_email (email after 24 hours unanswered), agent_only or email_only.
Access
Property
Value
OAuth scope
purchases:write
Effect
reversible
readOnlyHint
No
destructiveHint
Yes
idempotentHint
Yes
openWorldHint
No
The buyer also approves each permission on the consent page. See Authentication.
Arguments
Field
Type
Required
Description
request_id
string (uuid)
No
The Request’s id from list_requests.
offer_alerts
boolean
No
Whether the person is emailed new Offers.
check_frequency
adaptive, weekly, monthly, never
No
How often the person is asked if they still want it.
check_channels
agent_then_email, agent_only, email_only
No
Who asks: you, then email; only you; or only email.
agent_reachability
object
No
Turn email or polling on or off for this Request.
agent_reachability.channel
email, poll
Yes
agent_reachability.enabled
boolean
Yes
agent_reachability.expected_check_hours
integer or null
No
request_key
string
No
Optional. The same key repeats a change safely; one is derived when left out.
Input JSON Schema
{ "type": "object", "properties": { "request_id": { "type": "string", "format": "uuid", "description": "The Request’s id from list_requests." }, "offer_alerts": { "description": "Whether the person is emailed new Offers.", "type": "boolean" }, "check_frequency": { "type": "string", "enum": [ "adaptive", "weekly", "monthly", "never" ], "description": "How often the person is asked if they still want it." }, "check_channels": { "type": "string", "enum": [ "agent_then_email", "agent_only", "email_only" ], "description": "Who asks: you, then email; only you; or only email." }, "agent_reachability": { "type": "object", "properties": { "channel": { "type": "string", "enum": [ "email", "poll" ] }, "enabled": { "type": "boolean" }, "expected_check_hours": { "anyOf": [ { "type": "integer", "minimum": 1, "maximum": 720 }, { "type": "null" } ] } }, "required": [ "channel", "enabled" ], "additionalProperties": false, "description": "Turn email or polling on or off for this Request." }, "request_key": { "description": "Optional. The same key repeats a change safely; one is derived when left out.", "type": "string", "minLength": 8, "maxLength": 64 } }, "additionalProperties": false}