Create a campaign
Create a draft outreach campaign that sends from your Gmail.
https://api.rankparse.com/v1/outreach/campaignsFreeAPI keyCreates an empty draft campaign. Nothing is sent. Add emails with Add contacts, then launch it. Every campaign created here sends through Gmail.
Body parameters
namestringrequired1 to 200 characters after trimming. Otherwise 400 invalid_name.
your_domainstringrequiredThe website you are building links for. Lowercased, with http(s)://, www. and any path removed. Missing or empty returns 400 invalid_domain.
goalstringA note for the campaign record, for example what the outreach is for.
site_idstringA website id from List websites. It decides which Gmail mailbox the campaign sends from. Omit it (or send null) to leave the campaign unassigned, which sends from the default mailbox. A blank string returns 400 invalid_site_id; an archived website or one outside your workspace returns 404 site_not_found.
Response
idstringThe campaign id.
statusstringAlways draft.
max_contactsinteger500, the most contacts the campaign can hold.
site_idstring | nullThe website the campaign belongs to, or null.
Errors
| HTTP | Code | When |
|---|---|---|
| 400 | invalid_json | The body is not valid JSON. |
| 400 | invalid_name | name is missing, empty or longer than 200 characters. |
| 400 | invalid_domain | your_domain is missing or empty. |
| 400 | invalid_site_id | site_id is present but not a non-empty string. |
| 403 | capability_missing | Your role cannot manage outreach. |
| 404 | site_not_found | site_id is not an active website of your workspace. |
Plus the shared errors.
Related
MCP tool: outreach_create_campaign (accepts name, your_domain, goal, site_id). propose_outreach_send can create (or reuse) a campaign, add contacts and put them up for review in one call; see Create a proposal.