{"templateId":"openapi_docs","versions":[],"sharedDataIds":{"openAPIDocsStore":"oas-API Docs/@2023-11-29/api-public.yaml","sidebar":"sidebar-sidebar.yaml__api-docs_api-public"},"props":{"definitionId":"API Docs/@2023-11-29/api-public.yaml","dynamicMarkdocComponents":[],"baseSlug":"/api-docs/api-public","seo":{"title":"Bulk Senders","description":"A bulk sender object represents a campaign worker which sends messages\nto the borrowers returned by a campaign's query results.\n\nFor each row returned by the campaign in its query result a message is sent via the\n<a href=\"/api-docs/api-public/communicator/peach.communicator.handlers.handle_send\">Send endpoint</a>.\n\nSome of the query results columns are automatically mapped to the request body of the Send endpoint,\nthese columns are:\n- `caseId`\n- `contactId`\n- `context`\n- `interactionExternalId`\n- `isTransactional`\n- `loanId`\n- `previousInteractionId`\n- `statementId`\n- `sendAt`\n- `useTemplate`\n\nIn order for a bulk sender to function, at a minimum the\ncampaign's query results must return at least the column\n`borrowerId`.\n\nNote that bulk senders send with `{ strictUndefined: true }` so any missing context variables \nwill cause the send request to fail rather than sending with a default (empty) value, which is\nthe standard behavior for the `/communicator/send` endpoint.\n\nFor more details on required columns see\nper-`InteractionSubject` documentation for&nbsp;\n<a href=\"/api-docs/api-public/campaigns/peach.people.campaigns.handlers_runs.campaign_run_create\">Campaign run</a>.\n"},"itemId":"bulk-senders","disableAutoScroll":true,"metadata":{},"compilationErrors":[],"markdown":{"partials":{},"variables":{"rbac":{"teams":["anonymous"]},"user":{},"headers":{"accept":"*/*","accept-encoding":"br,gzip","host":"peach-docs-dev.redocly.app","user-agent":"Mozilla/5.0 AppleWebKit/537.36 (KHTML, like Gecko; compatible; ClaudeBot/1.0; +claudebot@anthropic.com)","via":"2.0 Caddy, 2.0 790dd2637efddd54756eabb102d0e234.cloudfront.net (CloudFront), 1.1 Caddy","x-amz-cf-id":"UfiVlWqrefEgCRSwUJ17vt47_anddMsGawZdozVvxIvERNjRqptieQ==","x-forwarded-for":"216.73.216.253, 44.206.14.241, 64.252.69.224","x-forwarded-host":"peach-docs-dev.redocly.app","x-forwarded-proto":"https","x-request-id":"cds-bc2d5289-e2ff-41ea-9825-3da55a3c0723"},"remoteAddr":{"hostname":"::ffff:10.0.1.185","port":55720},"lang":"default_locale","env":{"PUBLIC_REDOCLY_BRANCH_NAME":"develop"}}},"pagePropGetterError":{"message":"","name":""}},"slug":"/api-docs/api-public/bulk-senders","userData":{"isAuthenticated":false,"teams":["anonymous"]}}