Campaign
The campaign entity represents a fundraising campaign or effort associated with a commerce transaction. A notification can contain multiple campaigns, forming a hierarchy (e.g., a parent campaign with individual fundraiser pages beneath it).
| Field | Type | Description |
|---|---|---|
salesforceKey |
String | Salesforce platform key for the campaign. Used for CRM integration. |
key |
String | Unique identifier for the campaign in the dispatching platform. |
type |
String | Type of fundraising campaign. Values: "campaign", "organisation", "team", "fundraiser". |
name |
String | Display name of the fundraising campaign. |
description |
String | Detailed description of the campaign purpose and goals. |
pageUrl |
String | Public URL where the campaign page can be accessed. |
logoUrl |
String | URL to the campaign's logo or main image. |
status |
String | Current status of the campaign. Values: "draft", "live", "active". |
targetAmount |
Number | Target fundraising amount for the campaign. |
amount |
Number | Current amount raised for the campaign. |
currency |
String | Currency code for the campaign amounts (e.g., "USD", "EUR", "AUD"). |
primaryContact |
Person or Organisation | Primary contact person or organisation for the campaign. |
mailingAddress |
Address | Mailing address for the campaign organisation. |
otherAddress |
Address | Secondary or alternative address for the campaign. |
eventDate |
DateTime | Date when the campaign event takes place, if applicable. |
startDate |
DateTime | Campaign start date. |
endDate |
DateTime | Campaign end date. |
tribute |
Object | Tribute information if this is a memorial or honour campaign. |
custom |
Object | Custom key-value pairs for platform-specific data. |
questions |
Array of Question | Custom questions associated with the campaign. |
marketing |
Marketing | Marketing tracking information such as UTM parameters. |
createdAt |
DateTime | Timestamp when the campaign was created. |
modifiedAt |
DateTime | Timestamp when the campaign was last modified. |