Create a Campaign

curl --request POST \
  --url https://prod-api.raisedonors.com/api/Campaign \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "startDateTimeUtc": "2023-11-07T05:31:56Z",
  "endDateTimeUtc": "2023-11-07T05:31:56Z",
  "givingGoal": 123,
  "hasGivingGoal": true,
  "totalGiftGoal": 123,
  "hasTotalGiftGoal": true,
  "averageGiftGoal": 123,
  "hasAverageGiftGoal": true,
  "crmKey": "<string>",
  "crmKeys": {},
  "applySegmentToRecurringGifts": true,
  "canSync": true,
  "segments": [
    {
      "campaignId": 123,
      "name": "<string>",
      "code": "<string>",
      "description": "<string>",
      "externalIdentifier": "<string>"
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    startDate: '2023-11-07T05:31:56Z',
    endDate: '2023-11-07T05:31:56Z',
    description: '<string>',
    startDateTimeUtc: '2023-11-07T05:31:56Z',
    endDateTimeUtc: '2023-11-07T05:31:56Z',
    givingGoal: 123,
    hasGivingGoal: true,
    totalGiftGoal: 123,
    hasTotalGiftGoal: true,
    averageGiftGoal: 123,
    hasAverageGiftGoal: true,
    crmKey: '<string>',
    crmKeys: {},
    applySegmentToRecurringGifts: true,
    canSync: true,
    segments: [
      {
        campaignId: 123,
        name: '<string>',
        code: '<string>',
        description: '<string>',
        externalIdentifier: '<string>'
      }
    ]
  })
};

fetch('https://prod-api.raisedonors.com/api/Campaign', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://prod-api.raisedonors.com/api/Campaign"

payload = {
    "name": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "startDateTimeUtc": "2023-11-07T05:31:56Z",
    "endDateTimeUtc": "2023-11-07T05:31:56Z",
    "givingGoal": 123,
    "hasGivingGoal": True,
    "totalGiftGoal": 123,
    "hasTotalGiftGoal": True,
    "averageGiftGoal": 123,
    "hasAverageGiftGoal": True,
    "crmKey": "<string>",
    "crmKeys": {},
    "applySegmentToRecurringGifts": True,
    "canSync": True,
    "segments": [
        {
            "campaignId": 123,
            "name": "<string>",
            "code": "<string>",
            "description": "<string>",
            "externalIdentifier": "<string>"
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://prod-api.raisedonors.com/api/Campaign");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n  \"name\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"startDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n  \"endDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n  \"givingGoal\": 123,\n  \"hasGivingGoal\": true,\n  \"totalGiftGoal\": 123,\n  \"hasTotalGiftGoal\": true,\n  \"averageGiftGoal\": 123,\n  \"hasAverageGiftGoal\": true,\n  \"crmKey\": \"<string>\",\n  \"crmKeys\": {},\n  \"applySegmentToRecurringGifts\": true,\n  \"canSync\": true,\n  \"segments\": [\n    {\n      \"campaignId\": 123,\n      \"name\": \"<string>\",\n      \"code\": \"<string>\",\n      \"description\": \"<string>\",\n      \"externalIdentifier\": \"<string>\"\n    }\n  ]\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod-api.raisedonors.com/api/Campaign",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'startDate' => '2023-11-07T05:31:56Z',
    'endDate' => '2023-11-07T05:31:56Z',
    'description' => '<string>',
    'startDateTimeUtc' => '2023-11-07T05:31:56Z',
    'endDateTimeUtc' => '2023-11-07T05:31:56Z',
    'givingGoal' => 123,
    'hasGivingGoal' => true,
    'totalGiftGoal' => 123,
    'hasTotalGiftGoal' => true,
    'averageGiftGoal' => 123,
    'hasAverageGiftGoal' => true,
    'crmKey' => '<string>',
    'crmKeys' => [
        
    ],
    'applySegmentToRecurringGifts' => true,
    'canSync' => true,
    'segments' => [
        [
                'campaignId' => 123,
                'name' => '<string>',
                'code' => '<string>',
                'description' => '<string>',
                'externalIdentifier' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://prod-api.raisedonors.com/api/Campaign")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"startDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n  \"endDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n  \"givingGoal\": 123,\n  \"hasGivingGoal\": true,\n  \"totalGiftGoal\": 123,\n  \"hasTotalGiftGoal\": true,\n  \"averageGiftGoal\": 123,\n  \"hasAverageGiftGoal\": true,\n  \"crmKey\": \"<string>\",\n  \"crmKeys\": {},\n  \"applySegmentToRecurringGifts\": true,\n  \"canSync\": true,\n  \"segments\": [\n    {\n      \"campaignId\": 123,\n      \"name\": \"<string>\",\n      \"code\": \"<string>\",\n      \"description\": \"<string>\",\n      \"externalIdentifier\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.raisedonors.com/api/Campaign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"startDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n  \"endDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n  \"givingGoal\": 123,\n  \"hasGivingGoal\": true,\n  \"totalGiftGoal\": 123,\n  \"hasTotalGiftGoal\": true,\n  \"averageGiftGoal\": 123,\n  \"hasAverageGiftGoal\": true,\n  \"crmKey\": \"<string>\",\n  \"crmKeys\": {},\n  \"applySegmentToRecurringGifts\": true,\n  \"canSync\": true,\n  \"segments\": [\n    {\n      \"campaignId\": 123,\n      \"name\": \"<string>\",\n      \"code\": \"<string>\",\n      \"description\": \"<string>\",\n      \"externalIdentifier\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

const url = 'https://prod-api.raisedonors.com/api/Campaign';
const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    startDate: '2023-11-07T05:31:56Z',
    endDate: '2023-11-07T05:31:56Z',
    description: '<string>',
    startDateTimeUtc: '2023-11-07T05:31:56Z',
    endDateTimeUtc: '2023-11-07T05:31:56Z',
    givingGoal: 123,
    hasGivingGoal: true,
    totalGiftGoal: 123,
    hasTotalGiftGoal: true,
    averageGiftGoal: 123,
    hasAverageGiftGoal: true,
    crmKey: '<string>',
    crmKeys: {},
    applySegmentToRecurringGifts: true,
    canSync: true,
    segments: [
      {
        campaignId: 123,
        name: '<string>',
        code: '<string>',
        description: '<string>',
        externalIdentifier: '<string>'
      }
    ]
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "id": 88,
  "name": "Year-End Giving 2025",
  "description": "Year-end multi-channel giving campaign.",
  "startDate": "2025-11-01",
  "endDate": "2025-12-31",
  "duration": "60",
  "canSync": true,
  "crmKey": "2011",
  "crmKeyUrls": {
    "VirtuousCRM": {
      "crmKey": "2011",
      "url": "https://app.virtuoussoftware.com/Generosity/Campaign/Detail/2011"
    }
  },
  "applySegmentToRecurringGifts": true,
  "givingGoal": 250000,
  "givingGoalFormatted": "$250,000.00",
  "hasGivingGoal": true,
  "raisedAmount": "$87,340.00",
  "raisedPercentage": 34.9,
  "totalGiftGoal": 600,
  "hasTotalGiftGoal": true,
  "totalGifts": 467,
  "totalGiftsPercentage": 77.8,
  "totalDonors": 412,
  "averageGiftGoal": 250,
  "averageGiftGoalFormatted": "$250.00",
  "averageGiftAmount": "$187.02",
  "hasAverageGiftGoal": true,
  "totalVisitors": 5842,
  "conversionRate": "8.0%",
  "createdDateTime": "2025-10-15T09:00:00Z",
  "modifiedDateTime": "2025-11-15T08:00:00Z"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "name": [
      "The name field is required."
    ]
  },
  "instance": "/api/Campaign"
}

{
  "type": "https://tools.ietf.org/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The Authorization header is missing, malformed, or carries a token that is expired or revoked.",
  "instance": "/api/Campaign"
}

POST

https://prod-api.raisedonors.com

api

Campaign

Create a Campaign

curl --request POST \
  --url https://prod-api.raisedonors.com/api/Campaign \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "startDate": "2023-11-07T05:31:56Z",
  "endDate": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "startDateTimeUtc": "2023-11-07T05:31:56Z",
  "endDateTimeUtc": "2023-11-07T05:31:56Z",
  "givingGoal": 123,
  "hasGivingGoal": true,
  "totalGiftGoal": 123,
  "hasTotalGiftGoal": true,
  "averageGiftGoal": 123,
  "hasAverageGiftGoal": true,
  "crmKey": "<string>",
  "crmKeys": {},
  "applySegmentToRecurringGifts": true,
  "canSync": true,
  "segments": [
    {
      "campaignId": 123,
      "name": "<string>",
      "code": "<string>",
      "description": "<string>",
      "externalIdentifier": "<string>"
    }
  ]
}
'

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    startDate: '2023-11-07T05:31:56Z',
    endDate: '2023-11-07T05:31:56Z',
    description: '<string>',
    startDateTimeUtc: '2023-11-07T05:31:56Z',
    endDateTimeUtc: '2023-11-07T05:31:56Z',
    givingGoal: 123,
    hasGivingGoal: true,
    totalGiftGoal: 123,
    hasTotalGiftGoal: true,
    averageGiftGoal: 123,
    hasAverageGiftGoal: true,
    crmKey: '<string>',
    crmKeys: {},
    applySegmentToRecurringGifts: true,
    canSync: true,
    segments: [
      {
        campaignId: 123,
        name: '<string>',
        code: '<string>',
        description: '<string>',
        externalIdentifier: '<string>'
      }
    ]
  })
};

fetch('https://prod-api.raisedonors.com/api/Campaign', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://prod-api.raisedonors.com/api/Campaign"

payload = {
    "name": "<string>",
    "startDate": "2023-11-07T05:31:56Z",
    "endDate": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "startDateTimeUtc": "2023-11-07T05:31:56Z",
    "endDateTimeUtc": "2023-11-07T05:31:56Z",
    "givingGoal": 123,
    "hasGivingGoal": True,
    "totalGiftGoal": 123,
    "hasTotalGiftGoal": True,
    "averageGiftGoal": 123,
    "hasAverageGiftGoal": True,
    "crmKey": "<string>",
    "crmKeys": {},
    "applySegmentToRecurringGifts": True,
    "canSync": True,
    "segments": [
        {
            "campaignId": 123,
            "name": "<string>",
            "code": "<string>",
            "description": "<string>",
            "externalIdentifier": "<string>"
        }
    ]
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

using RestSharp;


var options = new RestClientOptions("https://prod-api.raisedonors.com/api/Campaign");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("Authorization", "<api-key>");
request.AddJsonBody("{\n  \"name\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"startDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n  \"endDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n  \"givingGoal\": 123,\n  \"hasGivingGoal\": true,\n  \"totalGiftGoal\": 123,\n  \"hasTotalGiftGoal\": true,\n  \"averageGiftGoal\": 123,\n  \"hasAverageGiftGoal\": true,\n  \"crmKey\": \"<string>\",\n  \"crmKeys\": {},\n  \"applySegmentToRecurringGifts\": true,\n  \"canSync\": true,\n  \"segments\": [\n    {\n      \"campaignId\": 123,\n      \"name\": \"<string>\",\n      \"code\": \"<string>\",\n      \"description\": \"<string>\",\n      \"externalIdentifier\": \"<string>\"\n    }\n  ]\n}", false);
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://prod-api.raisedonors.com/api/Campaign",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'name' => '<string>',
    'startDate' => '2023-11-07T05:31:56Z',
    'endDate' => '2023-11-07T05:31:56Z',
    'description' => '<string>',
    'startDateTimeUtc' => '2023-11-07T05:31:56Z',
    'endDateTimeUtc' => '2023-11-07T05:31:56Z',
    'givingGoal' => 123,
    'hasGivingGoal' => true,
    'totalGiftGoal' => 123,
    'hasTotalGiftGoal' => true,
    'averageGiftGoal' => 123,
    'hasAverageGiftGoal' => true,
    'crmKey' => '<string>',
    'crmKeys' => [
        
    ],
    'applySegmentToRecurringGifts' => true,
    'canSync' => true,
    'segments' => [
        [
                'campaignId' => 123,
                'name' => '<string>',
                'code' => '<string>',
                'description' => '<string>',
                'externalIdentifier' => '<string>'
        ]
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

HttpResponse<String> response = Unirest.post("https://prod-api.raisedonors.com/api/Campaign")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"startDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n  \"endDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n  \"givingGoal\": 123,\n  \"hasGivingGoal\": true,\n  \"totalGiftGoal\": 123,\n  \"hasTotalGiftGoal\": true,\n  \"averageGiftGoal\": 123,\n  \"hasAverageGiftGoal\": true,\n  \"crmKey\": \"<string>\",\n  \"crmKeys\": {},\n  \"applySegmentToRecurringGifts\": true,\n  \"canSync\": true,\n  \"segments\": [\n    {\n      \"campaignId\": 123,\n      \"name\": \"<string>\",\n      \"code\": \"<string>\",\n      \"description\": \"<string>\",\n      \"externalIdentifier\": \"<string>\"\n    }\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://prod-api.raisedonors.com/api/Campaign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"<string>\",\n  \"startDate\": \"2023-11-07T05:31:56Z\",\n  \"endDate\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"startDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n  \"endDateTimeUtc\": \"2023-11-07T05:31:56Z\",\n  \"givingGoal\": 123,\n  \"hasGivingGoal\": true,\n  \"totalGiftGoal\": 123,\n  \"hasTotalGiftGoal\": true,\n  \"averageGiftGoal\": 123,\n  \"hasAverageGiftGoal\": true,\n  \"crmKey\": \"<string>\",\n  \"crmKeys\": {},\n  \"applySegmentToRecurringGifts\": true,\n  \"canSync\": true,\n  \"segments\": [\n    {\n      \"campaignId\": 123,\n      \"name\": \"<string>\",\n      \"code\": \"<string>\",\n      \"description\": \"<string>\",\n      \"externalIdentifier\": \"<string>\"\n    }\n  ]\n}"

response = http.request(request)
puts response.read_body

const url = 'https://prod-api.raisedonors.com/api/Campaign';
const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    startDate: '2023-11-07T05:31:56Z',
    endDate: '2023-11-07T05:31:56Z',
    description: '<string>',
    startDateTimeUtc: '2023-11-07T05:31:56Z',
    endDateTimeUtc: '2023-11-07T05:31:56Z',
    givingGoal: 123,
    hasGivingGoal: true,
    totalGiftGoal: 123,
    hasTotalGiftGoal: true,
    averageGiftGoal: 123,
    hasAverageGiftGoal: true,
    crmKey: '<string>',
    crmKeys: {},
    applySegmentToRecurringGifts: true,
    canSync: true,
    segments: [
      {
        campaignId: 123,
        name: '<string>',
        code: '<string>',
        description: '<string>',
        externalIdentifier: '<string>'
      }
    ]
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

{
  "id": 88,
  "name": "Year-End Giving 2025",
  "description": "Year-end multi-channel giving campaign.",
  "startDate": "2025-11-01",
  "endDate": "2025-12-31",
  "duration": "60",
  "canSync": true,
  "crmKey": "2011",
  "crmKeyUrls": {
    "VirtuousCRM": {
      "crmKey": "2011",
      "url": "https://app.virtuoussoftware.com/Generosity/Campaign/Detail/2011"
    }
  },
  "applySegmentToRecurringGifts": true,
  "givingGoal": 250000,
  "givingGoalFormatted": "$250,000.00",
  "hasGivingGoal": true,
  "raisedAmount": "$87,340.00",
  "raisedPercentage": 34.9,
  "totalGiftGoal": 600,
  "hasTotalGiftGoal": true,
  "totalGifts": 467,
  "totalGiftsPercentage": 77.8,
  "totalDonors": 412,
  "averageGiftGoal": 250,
  "averageGiftGoalFormatted": "$250.00",
  "averageGiftAmount": "$187.02",
  "hasAverageGiftGoal": true,
  "totalVisitors": 5842,
  "conversionRate": "8.0%",
  "createdDateTime": "2025-10-15T09:00:00Z",
  "modifiedDateTime": "2025-11-15T08:00:00Z"
}

{
  "type": "https://tools.ietf.org/html/rfc7231#section-6.5.1",
  "title": "One or more validation errors occurred.",
  "status": 400,
  "errors": {
    "name": [
      "The name field is required."
    ]
  },
  "instance": "/api/Campaign"
}

{
  "type": "https://tools.ietf.org/html/rfc7235#section-3.1",
  "title": "Unauthorized",
  "status": 401,
  "detail": "The Authorization header is missing, malformed, or carries a token that is expired or revoked.",
  "instance": "/api/Campaign"
}

name and the startDate/endDate range identify it; set givingGoal, totalGiftGoal, or averageGiftGoal with the matching has* flag to track progress against a goal, and include segments to create the campaign’s segments in the same request. Returns the created campaign with its new id.

Authorizations

Authorization

string

header

required

JWT Authorization header using the Bearer scheme. Example: "Authorization: Bearer {token}"

Body

The campaign request.

name

string

required

The name of the campaign.

Minimum string length: 1

startDate

string<date-time>

required

The date the campaign starts.

Minimum string length: 1

endDate

string<date-time>

required

The date the campaign ends.

Minimum string length: 1

description

string | null

The description of the campaign.

startDateTimeUtc

string<date-time>

The UTC date and time the campaign starts. Send it instead of startDate to set the time as well.

endDateTimeUtc

string<date-time>

The UTC date and time the campaign ends. Send it instead of endDate to set the time as well.

givingGoal

number<double>

The giving goal for the campaign in the organization base currency.

hasGivingGoal

boolean

Whether the campaign has a giving goal. Set it to true for givingGoal to be tracked.

totalGiftGoal

integer<int32>

The number of gifts the campaign aims to bring in.

hasTotalGiftGoal

boolean

Whether the campaign has a total gift goal. Set it to true for totalGiftGoal to be tracked.

averageGiftGoal

number<double>

The target average gift amount in the organization base currency.

hasAverageGiftGoal

boolean

Whether the campaign has an average gift goal. Set it to true for averageGiftGoal to be tracked.

crmKey

string | null

The key that links the campaign to the matching record in your CRM.

crmKeys

object | null

The keys that link the campaign to matching records in your CRM, by CRM.

Show child attributes

applySegmentToRecurringGifts

boolean

Whether the segment applies to recurring gifts.

canSync

boolean

Whether the campaign can sync to your CRM.

segments

object[] | null

The segments to create with the campaign.

Show child attributes

Response

Represents the detailed view of a campaign returned by create, update, and single-campaign retrieval endpoints.

integer<int64>

The unique identifier of the campaign.

name

string | null

The name of the campaign.

description

string | null

The description of the campaign.

startDate

string | null

read-only

The date the campaign starts.

endDate

string | null

read-only

The date the campaign ends.

duration

string | null

read-only

The length of the campaign in days.

canSync

boolean

read-only

Whether the campaign can sync to your CRM.

crmKey

string | null

The key that links the campaign to the matching record in your CRM.

crmKeyUrls

object | null

CRM URLs for this campaign grouped by integration type.

Show child attributes

applySegmentToRecurringGifts

boolean

Whether the segment applies to recurring gifts.

givingGoal

number<double>

The giving goal for the campaign in the organization base currency.

givingGoalFormatted

string | null

read-only

The giving goal formatted for display in the organization currency (for example "$10,000.00").

hasGivingGoal

boolean

Whether the campaign has a giving goal.

raisedAmount

string | null

read-only

The total amount raised by the campaign.

raisedPercentage

number<double>

read-only

Percentage of the giving goal that has been raised (0–100).

totalGiftGoal

integer<int32>

The number of gifts the campaign aims to bring in.

hasTotalGiftGoal

boolean

Whether the campaign has a total gift goal.

totalGifts

integer<int32>

read-only

The number of gifts recorded for the campaign.

totalGiftsPercentage

number<double>

read-only

Percentage of the gift count goal that has been reached (0–100).

totalDonors

integer<int32>

read-only

The number of donors who have given to the campaign.

averageGiftGoal

number<double>

The target average gift amount in the organization base currency.

averageGiftGoalFormatted

string | null

read-only

The target average gift amount formatted for display (for example "$100.00").

averageGiftAmount

string | null

read-only

The actual average gift amount formatted for display.

hasAverageGiftGoal

boolean

Whether the campaign has an average gift goal.

totalVisitors

integer<int32>

read-only

The number of visitors recorded for the campaign.

conversionRate

string | null

read-only

The conversion rate for the campaign formatted as a percentage string (for example "12.3%").

createdDateTime

string | null

read-only

The UTC date and time the campaign was created.

modifiedDateTime

string | null

read-only

The UTC date and time the campaign was last modified.

Last modified on July 28, 2026

⌘I

Activity

Campaign

CustomField

Donor

EmailList

Gift

MotivationCode

OrgKnowledge

Premium

Project

Query

Raise

RecurringGift

Segment

Webhook

Zapier

Create a Campaign

Authorizations

Body

Response