Create a new campaign.

POST

https://prod-api.raisedonors.com/api/Campaign

POST

/api/Campaign

curl -X POST https://prod-api.raisedonors.com/api/Campaign \
     -H "Authorization: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Spring Fundraiser 2024",
  "startDate": "2024-04-01T08:00:00Z",
  "endDate": "2024-06-30T23:59:59Z"
}'

{
  "id": 1024,
  "name": "Spring Fundraiser 2024",
  "description": "Annual spring campaign to support community outreach programs.",
  "startDate": "2024-04-01T08:00:00Z",
  "endDate": "2024-06-30T23:59:59Z",
  "duration": "3 months",
  "canSync": true,
  "crmKey": "SF2024-CAMPAIGN",
  "crmKeyUrls": {},
  "applySegmentToRecurringGifts": true,
  "givingGoal": 50000,
  "givingGoalFormatted": "$50,000.00",
  "hasGivingGoal": true,
  "raisedAmount": "$12,500.00",
  "raisedPercentage": 25,
  "totalGiftGoal": 200,
  "hasTotalGiftGoal": true,
  "totalGifts": 50,
  "totalGiftsPercentage": 25,
  "totalDonors": 45,
  "averageGiftGoal": 250,
  "averageGiftGoalFormatted": "$250.00",
  "averageGiftAmount": "$250.00",
  "hasAverageGiftGoal": true,
  "totalVisitors": 1200,
  "conversionRate": "3.8%",
  "createdDateTime": "2024-03-01T12:00:00Z",
  "modifiedDateTime": "2024-03-15T15:30:00Z"
}

Authentication

Authorizationstring

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

Request

The campaign request.

namestringRequired>=1 character

startDatedatetimeRequired

endDatedatetimeRequired

descriptionstring or nullOptional

startDateTimeUtcdatetimeOptional

endDateTimeUtcdatetimeOptional

givingGoaldoubleOptional

hasGivingGoalbooleanOptional

totalGiftGoalintegerOptional

hasTotalGiftGoalbooleanOptional

averageGiftGoaldoubleOptional

hasAverageGiftGoalbooleanOptional

crmKeystring or nullOptional

crmKeysmap from strings to strings or nullOptional

applySegmentToRecurringGiftsbooleanOptional

canSyncbooleanOptional

segmentslist of objects or nullOptional

Response

idlongOptional

Gets or sets the identifier.

namestring or nullOptional

Gets or sets the name.

descriptionstring or nullOptional

Gets or sets the description.

startDatestring or nullOptionalRead-only

Gets or sets the start date.

endDatestring or nullOptionalRead-only

Gets or sets the end date.

durationstring or nullOptionalRead-only

Gets or sets the duration.

canSyncbooleanOptionalRead-only

Gets or sets the can sync.

crmKeystring or nullOptional

Gets or sets the crmkey.

crmKeyUrlsmap from strings to objects or nullOptional

CRM URLs for this campaign grouped by integration type.

applySegmentToRecurringGiftsbooleanOptional

Gets or sets the apply segment to recurring gifts.

givingGoaldoubleOptional

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

givingGoalFormattedstring or nullOptionalRead-only

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

hasGivingGoalbooleanOptional

Gets or sets the has giving goal.

raisedAmountstring or nullOptionalRead-only

Gets or sets the raised amount.

raisedPercentagedoubleOptionalRead-only

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

totalGiftGoalintegerOptional

Gets or sets the total gift goal.

hasTotalGiftGoalbooleanOptional

Gets or sets the has total gift goal.

totalGiftsintegerOptionalRead-only

Gets or sets the total gifts.

totalGiftsPercentagedoubleOptionalRead-only

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

totalDonorsintegerOptionalRead-only

Gets or sets the total donors.

averageGiftGoaldoubleOptional

The target average gift amount in the organization base currency.

averageGiftGoalFormattedstring or nullOptionalRead-only

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

averageGiftAmountstring or nullOptionalRead-only

The actual average gift amount formatted for display.

hasAverageGiftGoalbooleanOptional

Gets or sets the has average gift goal.

totalVisitorsintegerOptionalRead-only

Gets or sets the total visitors.

conversionRatestring or nullOptionalRead-only

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

createdDateTimestring or nullOptionalRead-only

Gets or sets the created date time.

modifiedDateTimestring or nullOptionalRead-only

Gets or sets the modified date time.

Errors

400

Bad Request Error