Create a campaign
lob_campaigns_createCreate a campaign to organize bulk mail sends with shared creative, schedule, and audience. Set immediate or scheduled delivery.
Instructions
Create a campaign — a container for batched mail-piece sends with a shared creative, schedule, and audience. Creating a campaign does not by itself send mail; you trigger sends per Lob docs.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | Display name for the campaign. | |
| description | No | ||
| schedule_type | No | Whether the campaign should send immediately or on a schedule. | |
| send_date | No | ISO 8601 timestamp for scheduled campaigns. | |
| target_delivery_date | No | ||
| cancel_window_campaign_minutes | No | Minutes before send during which the campaign can still be cancelled. | |
| metadata | No | Up to 20 string key/value pairs of arbitrary metadata to attach to the resource. | |
| extra | No | Additional Lob API parameters not enumerated above. Merged into the request body verbatim. See https://docs.lob.com for the full parameter list per resource. |