Campaign
Campaigns are marketing initiatives like advertisements, emails, phone calls and trade shows that you can use to target your leads and prospects. Campaign object allows you to perform the following operations:
- Retrieve a specific campaign or a list of campaigns
- Create a campaign
- Update a campaign
- Delete a campaign
- cURL
- NODE.JS
- PHP
- C#
- PYTHON
- JAVA
The Campaign Object
asterisk denotes requiredName | Description | Format | Attributes |
---|---|---|---|
campaignTypeId | Identifier of the campaign type | uuid | Filterable |
endDate | Date when the campaign is scheduled to end in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
name | Name of the campaign | string | Filterable, Sortable MaxLength = 65 |
startDate | Date when the campaign is scheduled to start in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
actualCost | Actual cost associated with executing the campaign | double | Filterable, Sortable |
budgetedCost | Estimated cost of the campaign | double | Filterable, Sortable |
campaignStatus | The campaign status, i.e., the stage of the campaign's activity or progress, e.g., Budgeted, Planned, Approved, etc. | string | Filterable, Sortable |
campaignStatusId | Identifier of the campaign status | uuid | Filterable |
campaignType | Type of the campaign, e.g., Email, Newsletter, Referral Program, Social Media, etc. | string | Filterable, Sortable |
createdById | Identifier of the user who created this object | uuid | Filterable |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
customFields []Array: Parent object can have multiple instances of this nested object under it. | Represents a list of custom fields | CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. | |
expectedResponsePercent | Percentage of recipients expected to respond to the campaign | string | Filterable MaxLength = 50 |
expectedRevenue | Revenue or income expected from the opportunities created via the campaign | double | Filterable, Sortable |
id | Object identifier | uuid | Filterable |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time | Filterable, Sortable |
lastUpdatedById | Identifier of the user who last updated this object | uuid | Filterable |
objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectState Enumerated type: Click to see possible values and their descriptions. | |
recipients []Array: Parent object can have multiple instances of this nested object under it. | List of recipients included in the campaign | CampaignRecipient Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. | |
status | Current status of the campaign, e.g., Active or Inactive | Status Enumerated type: Click to see possible values and their descriptions. | |
token | Represents the token for update operations | int32 | |
version | Implements concurrency on this object | byte | |
workflow []Array: Parent object can have multiple instances of this nested object under it. | List of workflow | WorkflowState Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
Campaign List
Use this method to retrieve a list of campaigns. You can optionally pass where, orderBy, and page as query parameters to filter the result. Use the fields parameter to request a subset of the model. By default, a complete model is returned. The expand parameter is used to request nested properties in the model.
Request URL
Method Overview
HTTP Method:
GET
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Campaign
Required Scopes:
read:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
fields | Query | Specifies the model properties you want in the response body | string |
where | Query | Specifies only those records that match an expression in the query | string |
orderBy | Query | Specifies the order of the records | string |
page | Query | Specifies the page number and number of records on each page | string |
expand | Query | Specifies the nested model properties you want in the response body | string |
Response Body
Name | Description | Format |
---|---|---|
campaignTypeId | Identifier of the campaign type | uuid |
endDate | Date when the campaign is scheduled to end in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
name | Name of the campaign | string |
startDate | Date when the campaign is scheduled to start in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
actualCost | Actual cost associated with executing the campaign | double |
budgetedCost | Estimated cost of the campaign | double |
campaignStatus | The campaign status, i.e., the stage of the campaign's activity or progress, e.g., Budgeted, Planned, Approved, etc. | string |
campaignStatusId | Identifier of the campaign status | uuid |
campaignType | Type of the campaign, e.g., Email, Newsletter, Referral Program, Social Media, etc. | string |
createdById | Identifier of the user who created this object | uuid |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
customFields []Array: Parent object can have multiple instances of this nested object under it. | Represents a list of custom fields | CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
expectedResponsePercent | Percentage of recipients expected to respond to the campaign | string |
expectedRevenue | Revenue or income expected from the opportunities created via the campaign | double |
id | Object identifier | uuid |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
lastUpdatedById | Identifier of the user who last updated this object | uuid |
objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
recipients []Array: Parent object can have multiple instances of this nested object under it. | List of recipients included in the campaign | CampaignRecipient Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
status | Current status of the campaign, e.g., Active or Inactive | StatusEnumerated type: Click to see possible values and their descriptions. |
token | Represents the token for update operations | int32 |
version | Implements concurrency on this object | byte |
workflow []Array: Parent object can have multiple instances of this nested object under it. | List of workflow | WorkflowState Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
[
{
"campaignTypeId": "4fdacdb6-a1d2-4414-8896-90317320eb25",
"endDate": "2024-11-04T05:01:30Z",
"name": "Campaign",
"startDate": "2024-11-04T05:01:30Z",
"actualCost": 1,
"budgetedCost": 1,
"campaignStatus": "campaignStatus",
"campaignStatusId": "a1062059-3066-4375-b09f-55860cf5f58a",
"campaignType": "campaignType",
"createdById": "d6a5cf2e-cc8c-439e-a840-c41e06fc80c2",
"createdOn": "2024-11-04T05:01:30Z",
"customFields": [
{
"definitionId": "d8ee53dd-7be8-4c7f-8350-fd795214b117",
"createdById": "9e22e1a0-4a0e-4fc7-87f5-57ebf20e6009",
"createdOn": "2024-11-04T05:01:30Z",
"description": "CustomFieldData Description",
"id": "3692b333-9747-479a-a443-f3e8a995ca1c",
"label": "label",
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "f3684454-fc3d-4010-98c0-1170353fdeb4",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"expectedResponsePercent": "expectedResponsePercent",
"expectedRevenue": 1,
"id": "3163ffe8-a21d-4d38-88f9-18ff29259767",
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "6436ae15-b0bb-4158-a140-296a221b504a",
"objectState": null,
"recipients": [
{
"campaignId": "faab59ab-4f9e-4fbf-807b-f0eb29f3781a",
"recipientId": "e1450186-7cae-4ae9-a40a-332f4b9e5847",
"recipientType": null,
"createdById": "5681ef80-0d9a-40dc-a21a-7e3ed2f0518a",
"createdOn": "2024-11-04T05:01:30Z",
"id": "b5eb1427-9b58-4ce9-a5e5-48f56624a474",
"isGroup": true,
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "5209dfcb-d576-4dee-8d43-b6d862372b04",
"objectState": null,
"recipient": "recipient",
"recipientStatus": null,
"responded": true,
"sent": true,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"status": null,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw==",
"workflow": [
{
"actionById": "faa5f9e3-1fe6-4b38-a6db-3cd80d007fec",
"action": null,
"actionBy": "actionBy",
"createdById": "2716d9c2-1bfc-4673-8da5-c219ddbd477e",
"createdOn": "2024-11-04T05:01:30Z",
"date": "2024-11-04T05:01:30Z",
"id": "c3eb17b1-cf4c-49e9-aa62-cddec00947a9",
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "981274d8-3433-4efc-a615-cf21bb91fc84",
"memo": "memo",
"objectState": null,
"sendTo": "sendTo",
"sendToId": "03350cc2-9d2d-4866-8506-95234e8c1f8f",
"submitTo": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
]
}
]
Retrieve a Campaign
Use this method to retrieve a specific campaign. Pass id as the parameter.
Request URL
Method Overview
HTTP Method:
GET
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Campaign
Required Scopes:
read:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
id | Path | Campaign identifier | string |
Response Body
Name | Description | Format |
---|---|---|
campaignTypeId | Identifier of the campaign type | uuid |
endDate | Date when the campaign is scheduled to end in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
name | Name of the campaign | string |
startDate | Date when the campaign is scheduled to start in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
actualCost | Actual cost associated with executing the campaign | double |
budgetedCost | Estimated cost of the campaign | double |
campaignStatus | The campaign status, i.e., the stage of the campaign's activity or progress, e.g., Budgeted, Planned, Approved, etc. | string |
campaignStatusId | Identifier of the campaign status | uuid |
campaignType | Type of the campaign, e.g., Email, Newsletter, Referral Program, Social Media, etc. | string |
createdById | Identifier of the user who created this object | uuid |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
customFields []Array: Parent object can have multiple instances of this nested object under it. | Represents a list of custom fields | CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
expectedResponsePercent | Percentage of recipients expected to respond to the campaign | string |
expectedRevenue | Revenue or income expected from the opportunities created via the campaign | double |
id | Object identifier | uuid |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
lastUpdatedById | Identifier of the user who last updated this object | uuid |
objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
recipients []Array: Parent object can have multiple instances of this nested object under it. | List of recipients included in the campaign | CampaignRecipient Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
status | Current status of the campaign, e.g., Active or Inactive | StatusEnumerated type: Click to see possible values and their descriptions. |
token | Represents the token for update operations | int32 |
version | Implements concurrency on this object | byte |
workflow []Array: Parent object can have multiple instances of this nested object under it. | List of workflow | WorkflowState Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
{
"campaignTypeId": "551db287-b761-4f31-b4d7-55f84ce11386",
"endDate": "2024-11-04T05:01:30Z",
"name": "Campaign",
"startDate": "2024-11-04T05:01:30Z",
"actualCost": 1,
"budgetedCost": 1,
"campaignStatus": "campaignStatus",
"campaignStatusId": "d3ddc441-148d-490a-b20d-58740cd4bd7c",
"campaignType": "campaignType",
"createdById": "6040c055-b357-40ba-a7b9-e84958a5a175",
"createdOn": "2024-11-04T05:01:30Z",
"customFields": [
{
"definitionId": "cd012102-407d-41a4-9173-6ce8b6aa7745",
"createdById": "dd0432fb-210f-4372-bc20-a47bb4f43904",
"createdOn": "2024-11-04T05:01:30Z",
"description": "CustomFieldData Description",
"id": "3283c701-9674-42f2-9e16-0d74c618a48d",
"label": "label",
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "dbe25349-43f7-44a2-aea6-9d28e588cf66",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"expectedResponsePercent": "expectedResponsePercent",
"expectedRevenue": 1,
"id": "387c12ce-3419-497e-8169-57ca3d46826e",
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "bd45fff5-81f1-499c-ac99-232a0b41e42f",
"objectState": null,
"recipients": [
{
"campaignId": "1c9a8227-2d6a-41c8-9728-4c0282a3eb7f",
"recipientId": "2a1b9349-a52f-4136-a72f-17f6ff895e59",
"recipientType": null,
"createdById": "670b6dd0-d103-40e5-b5e8-ebcdc29bc4eb",
"createdOn": "2024-11-04T05:01:30Z",
"id": "3a2bce76-cef5-40fe-b1a9-9bc86c3c1f44",
"isGroup": true,
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "8a2e6d9a-2153-4bd6-bbae-19e2e59b2b2b",
"objectState": null,
"recipient": "recipient",
"recipientStatus": null,
"responded": true,
"sent": true,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"status": null,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw==",
"workflow": [
{
"actionById": "9065b4f9-98c8-4d89-9efa-d96fc48fd3b6",
"action": null,
"actionBy": "actionBy",
"createdById": "b1deb588-8e3a-4f6a-b254-aa8e6377f545",
"createdOn": "2024-11-04T05:01:30Z",
"date": "2024-11-04T05:01:30Z",
"id": "9cb13a50-6e3f-4fc2-b3bd-d6e9ac94c11e",
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "20f6df06-b9e5-4300-9414-9c3104839692",
"memo": "memo",
"objectState": null,
"sendTo": "sendTo",
"sendToId": "d583e180-f847-4fea-9297-b2cd21c9ec1e",
"submitTo": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
]
}
Create a Campaign
Use this method to save a campaign. Pass campaign as the parameter.
Request URL
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Campaign
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
body | Body | Campaign object | Campaign |
Response Body
Name | Description | Format |
---|---|---|
campaignTypeId | Identifier of the campaign type | uuid |
endDate | Date when the campaign is scheduled to end in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
name | Name of the campaign | string |
startDate | Date when the campaign is scheduled to start in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
actualCost | Actual cost associated with executing the campaign | double |
budgetedCost | Estimated cost of the campaign | double |
campaignStatus | The campaign status, i.e., the stage of the campaign's activity or progress, e.g., Budgeted, Planned, Approved, etc. | string |
campaignStatusId | Identifier of the campaign status | uuid |
campaignType | Type of the campaign, e.g., Email, Newsletter, Referral Program, Social Media, etc. | string |
createdById | Identifier of the user who created this object | uuid |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
customFields []Array: Parent object can have multiple instances of this nested object under it. | Represents a list of custom fields | CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
expectedResponsePercent | Percentage of recipients expected to respond to the campaign | string |
expectedRevenue | Revenue or income expected from the opportunities created via the campaign | double |
id | Object identifier | uuid |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
lastUpdatedById | Identifier of the user who last updated this object | uuid |
objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
recipients []Array: Parent object can have multiple instances of this nested object under it. | List of recipients included in the campaign | CampaignRecipient Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
status | Current status of the campaign, e.g., Active or Inactive | StatusEnumerated type: Click to see possible values and their descriptions. |
token | Represents the token for update operations | int32 |
version | Implements concurrency on this object | byte |
workflow []Array: Parent object can have multiple instances of this nested object under it. | List of workflow | WorkflowState Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
{
"campaignTypeId": "c82b353a-1314-423a-ba31-593b3c5681aa",
"endDate": "2024-11-04T05:01:30Z",
"name": "Campaign",
"startDate": "2024-11-04T05:01:30Z",
"actualCost": 1,
"budgetedCost": 1,
"campaignStatus": "campaignStatus",
"campaignStatusId": "fed51e55-9ed2-459d-9405-edbcc0eb1fba",
"campaignType": "campaignType",
"createdById": "892c2a02-cbab-482f-a7c0-fac6c300ecd5",
"createdOn": "2024-11-04T05:01:30Z",
"customFields": [
{
"definitionId": "1662c364-862d-4f4f-a7a0-0225aee8089e",
"createdById": "de87b185-aa9b-4cf1-adcc-2cbfc7a0a72a",
"createdOn": "2024-11-04T05:01:30Z",
"description": "CustomFieldData Description",
"id": "3b16eb88-65bc-4373-96e9-921bea2c8154",
"label": "label",
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "5843e901-76b8-4d58-ba65-1f8a5052e317",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"expectedResponsePercent": "expectedResponsePercent",
"expectedRevenue": 1,
"id": "ece01762-a356-4a83-a946-b4146ff6f6b6",
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "78467c36-5781-4d5b-93f8-24f0ae8188c9",
"objectState": null,
"recipients": [
{
"campaignId": "e8f00418-8300-4538-9f11-998dc4a58d5d",
"recipientId": "a6c7d7c3-e4dd-4098-a388-0f30e3041615",
"recipientType": null,
"createdById": "7ee4d1ed-2402-4b02-bf32-66b2949033fa",
"createdOn": "2024-11-04T05:01:30Z",
"id": "94b13dfe-ef79-48d7-a043-cb4f7950f24c",
"isGroup": true,
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "8f15bee6-c720-4b0c-854d-b51d1bab5b3e",
"objectState": null,
"recipient": "recipient",
"recipientStatus": null,
"responded": true,
"sent": true,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"status": null,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw==",
"workflow": [
{
"actionById": "af4ed2aa-6d5b-495a-9584-0e7a9e28936e",
"action": null,
"actionBy": "actionBy",
"createdById": "b9bd4dde-6113-4e84-bf8b-e0bce4e74ee0",
"createdOn": "2024-11-04T05:01:30Z",
"date": "2024-11-04T05:01:30Z",
"id": "f23251c6-19f5-4c11-9721-df61e703d6b4",
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "5dc37dc0-951a-4ca1-ae07-9844eb33a993",
"memo": "memo",
"objectState": null,
"sendTo": "sendTo",
"sendToId": "435cb71b-596a-4e18-b4c4-19c20f0febfd",
"submitTo": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
]
}
Create a Campaign List
Use this method to save multiple campaigns. Pass model as the parameter.
Request URL
Method Overview
HTTP Method:
POST
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Campaign
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
body | Body | Campaign object | CampaignBatchRequest |
Response Body
Name | Description | Format |
---|---|---|
batchSize | Represents the number of entities in a batch | int64 |
createdById | Identifier of the user who created this object | uuid |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
id | Object identifier | uuid |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
lastUpdatedById | Identifier of the user who last updated this object | uuid |
objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
progress | Represents the total number of entities processed | int64 |
status | Represents the status of a job e.g., ready, running, completed, or terminated | string |
token | Represents the token for update operations | int32 |
type | Represents the type of a job e.g., create, update, or delete | string |
version | Implements concurrency on this object | byte |
{
"batchSize": 0,
"createdById": "314246a6-fc33-4bc3-9d61-e229bc61ddbf",
"createdOn": "2024-11-04T05:01:30Z",
"id": "e7a0bbe0-4117-43f5-93fd-9bdaac56a5e4",
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "94ba36b2-746f-4aa4-a0d7-f9613c383a1e",
"objectState": null,
"progress": 0,
"status": "status",
"token": 0,
"type": "type",
"version": "U3dhZ2dlciByb2Nrcw=="
}
Update a Campaign
Use this method to update a campaign. Pass id and campaign as the parameters.
Request URL
Method Overview
HTTP Method:
PUT
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Campaign
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
id | Path | Campaign identifier | string |
body | Body | Campaign object | Campaign |
Response Body
Name | Description | Format |
---|---|---|
campaignTypeId | Identifier of the campaign type | uuid |
endDate | Date when the campaign is scheduled to end in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
name | Name of the campaign | string |
startDate | Date when the campaign is scheduled to start in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
actualCost | Actual cost associated with executing the campaign | double |
budgetedCost | Estimated cost of the campaign | double |
campaignStatus | The campaign status, i.e., the stage of the campaign's activity or progress, e.g., Budgeted, Planned, Approved, etc. | string |
campaignStatusId | Identifier of the campaign status | uuid |
campaignType | Type of the campaign, e.g., Email, Newsletter, Referral Program, Social Media, etc. | string |
createdById | Identifier of the user who created this object | uuid |
createdOn | Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
customFields []Array: Parent object can have multiple instances of this nested object under it. | Represents a list of custom fields | CustomFieldData Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
expectedResponsePercent | Percentage of recipients expected to respond to the campaign | string |
expectedRevenue | Revenue or income expected from the opportunities created via the campaign | double |
id | Object identifier | uuid |
lastUpdated | Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ss | date-time |
lastUpdatedById | Identifier of the user who last updated this object | uuid |
objectState | Represents the state of the object. e.g., new, unchanged, modified or deleted | ObjectStateEnumerated type: Click to see possible values and their descriptions. |
recipients []Array: Parent object can have multiple instances of this nested object under it. | List of recipients included in the campaign | CampaignRecipient Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
status | Current status of the campaign, e.g., Active or Inactive | StatusEnumerated type: Click to see possible values and their descriptions. |
token | Represents the token for update operations | int32 |
version | Implements concurrency on this object | byte |
workflow []Array: Parent object can have multiple instances of this nested object under it. | List of workflow | WorkflowState Nested object: Click to see its details. To retrieve the details of this object via list endpoints, you must use the Expand parameter. |
{
"campaignTypeId": "358edf8e-25d3-43b2-817c-b7d92ecc7349",
"endDate": "2024-11-04T05:01:30Z",
"name": "Campaign",
"startDate": "2024-11-04T05:01:30Z",
"actualCost": 1,
"budgetedCost": 1,
"campaignStatus": "campaignStatus",
"campaignStatusId": "6e349146-5097-4212-8a2d-8d6e070ed748",
"campaignType": "campaignType",
"createdById": "74fbab1d-8c93-4b83-a463-a4ad0d09d3e8",
"createdOn": "2024-11-04T05:01:30Z",
"customFields": [
{
"definitionId": "d6b9e849-7a26-4459-8556-d0908018acbb",
"createdById": "23ab2fa8-d58a-49a6-b6ef-0ba00315ee50",
"createdOn": "2024-11-04T05:01:30Z",
"description": "CustomFieldData Description",
"id": "4f82dafb-4b32-4968-94b8-0f1313c22db9",
"label": "label",
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "f23b030f-8e55-4924-bbb2-35a2db5a35fc",
"objectState": null,
"token": 0,
"type": null,
"value": "value",
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"expectedResponsePercent": "expectedResponsePercent",
"expectedRevenue": 1,
"id": "f4fb25f9-c68d-4874-b1a5-e5bf96d92426",
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "cdacda9d-3fa7-434e-a57e-cc7f9c1723ae",
"objectState": null,
"recipients": [
{
"campaignId": "ca7e0b09-6dad-4765-8545-7b2e1c6c70bd",
"recipientId": "3b93c298-0dac-4e58-9a6f-6e268c924345",
"recipientType": null,
"createdById": "9c6071ed-106b-4764-9d24-d075bee95b83",
"createdOn": "2024-11-04T05:01:30Z",
"id": "0edf4576-0b45-4069-bb4e-27bd9d6f8962",
"isGroup": true,
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "98fb7ac3-4c11-4063-ba33-db976ade786a",
"objectState": null,
"recipient": "recipient",
"recipientStatus": null,
"responded": true,
"sent": true,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw=="
}
],
"status": null,
"token": 0,
"version": "U3dhZ2dlciByb2Nrcw==",
"workflow": [
{
"actionById": "89f69d61-a395-4087-be63-807cf4310ade",
"action": null,
"actionBy": "actionBy",
"createdById": "13f90b2f-7f58-4b99-bf74-392194324020",
"createdOn": "2024-11-04T05:01:30Z",
"date": "2024-11-04T05:01:30Z",
"id": "200e3eed-950d-4486-b3ca-851fe2c29787",
"lastUpdated": "2024-11-04T05:01:30Z",
"lastUpdatedById": "3d91594b-0191-41ef-b1bf-6e1ac810acbb",
"memo": "memo",
"objectState": null,
"sendTo": "sendTo",
"sendToId": "9659e2d9-0549-42db-a8cb-87714229fbc2",
"submitTo": null,
"token": 0,
"type": null,
"version": "U3dhZ2dlciByb2Nrcw=="
}
]
}
Delete a Campaign
Use this method to delete a specific campaign. Pass id as the parameter.
Request URL
Method Overview
HTTP Method:
DELETE
Content Type:
application/json
Response Format:
N/A
Requires Authentication?
Yes
Headers:
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
id | Path | Campaign identifier | string |
Patch a Campaign
Use this method to perform partial modifications to a campaign. Pass id and patch document as parameters.
Request URL
Method Overview
HTTP Method:
PATCH
Content Type:
application/json
Response Format:
json
Requires Authentication?
Yes
Headers:
Module:
Campaign
Required Scopes:
readwrite:core
Required Subscription:
View Subscription
Request Parameters asterisk denotes required
Name | Parameter Type | Description | Format |
---|---|---|---|
id | Path | Campaign identifier | string |
body | Body | A document containing an array of objects with each object representing a single operation to be performed | CampaignPatchDocument |
Response Body
Name | Description | Format |
---|