> ## Documentation Index
> Fetch the complete documentation index at: https://domoinc-openapi-sync-dataflows.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Campaigns API

### Intro

Campaigns supports the ability to start a campaign from a call to the API

### Triggering a Campaign

##### Endpoint

The endpoint to call to trigger a campaign is:

[https://campaigns-prod.domolabs.io/api/v1/campaigns/start](https://campaigns-prod.domolabs.io/api/v1/campaigns/start "https://campaigns-prod.domolabs.io/api/v1/campaigns/start")

##### Object

Call a POST event to the endpoint above with the following JSON object:

```json theme={"dark"}
{
  "campaignId": 0,
  "domoAccessToken": "",
  "domoAccessTokenOwnerEmailAddress": "",
  "emailAddresses": [],
  "instance": ""
}
```

###### Campaign Id

The id of the campaign you want to start.  You can get the campaign id by editing the campaign and going to the "SETTINGS" tab:

<Frame>
  <img alt="CampaignId.png" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/3A4Whxu66v2UwluW/images/kb/ka05w00000123V9-00N5w00000Ri7BU-0EM5w000005vOOT.png?fit=max&auto=format&n=3A4Whxu66v2UwluW&q=85&s=30cae15f1b5432243f80ede05f41a598" style={{width: 476, height: 300}} width="1166" height="735" data-path="images/kb/ka05w00000123V9-00N5w00000Ri7BU-0EM5w000005vOOT.png" />
</Frame>

###### Domo Access Token

A Domo access token that has been generated in Domo.  You can generate Domo Access Tokens by logging in,  going to the Admin Settings section, going to "Security", and selecting "Access tokens".  There you can simply generate a new access token to use for calls to the API.

<Frame>
  <img alt="AccessToken.PNG" src="https://mintcdn.com/domoinc-openapi-sync-dataflows/3A4Whxu66v2UwluW/images/kb/ka05w00000123UJ-00N5w00000Ri7BU-0EM5w000005vOKU.png?fit=max&auto=format&n=3A4Whxu66v2UwluW&q=85&s=42fddc435d6143ef7a2f883762302f00" style={{width: 588, height: 350}} width="1271" height="756" data-path="images/kb/ka05w00000123UJ-00N5w00000Ri7BU-0EM5w000005vOKU.png" />
</Frame>

###### Domo Access Token Owner Email Address

The email address of the user who owns the **Domo Access Token** specified above.

###### Email Addresses (OPTIONAL)

A list of email addresses the campaign should be delivered to.  If no email addresses are selected, the entire campaign will be started and delivered to all recipients in the distribution list.

###### Instance

You Domo instance (e.g. [domo.domo.com](http://domo.domo.com) ).

##### Summary

<table class="mt-responsive-table" data-aura-rendered-by="33:208;a"><tbody><tr><th colspan="1" rowspan="1"> Path </th><td class="mt-colspan" colspan="1" rowspan="1"><code><a href="https://campaigns-prod.domolabs.io/api/v1/campaigns/start" target="_blank" title="https://campaigns-prod.domolabs.io/api/v1/campaigns/start"> [https://campaigns-prod.domolabs.io/api/v1/campaigns/start](https://campaigns-prod.domolabs.io/api/v1/campaigns/start) </a></code></td></tr><tr><td colspan="1" rowspan="1"> Since version </td><td class="mt-colspan" colspan="1" rowspan="1"> 1.0 </td></tr><tr><th colspan="1" rowspan="1"> Description </th><td class="mt-colspan" colspan="1" rowspan="1"> Run a campaign and send an email to a everyone in the distribution list OR to a selected list of people </td></tr><tr><th colspan="1" rowspan="1"> Auth </th><td class="mt-colspan" colspan="1" rowspan="1"> NONE, Roles: anonymous </td></tr><tr><th colspan="2" rowspan="1"> Produces </th></tr><tr><td class="mt-colspan" colspan="2" rowspan="1"><code> application/json </code></td></tr><tr><th colspan="2" rowspan="1"> Consumes </th></tr><tr><td class="mt-colspan" colspan="2" rowspan="1"><code> application/json </code></td></tr><tr><th colspan="2" rowspan="1"> Body object </th></tr><tr><td class="mt-colspan" colspan="2" rowspan="1"><code> startcampaign </code></td></tr><tr><th colspan="2" rowspan="1"> Response status code </th></tr><tr><td class="mt-colspan" colspan="2" rowspan="1"><code> 200 - OK </code></td></tr><tr><th colspan="2" rowspan="1"> Response object </th></tr><tr><td class="mt-colspan" colspan="2" rowspan="1"><code> void </code></td></tr></tbody></table>
