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
NameDescriptionFormatAttributes
campaignTypeId Identifier of the campaign typeuuidFilterable
endDate Date when the campaign is scheduled to end in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-timeFilterable, Sortable
name Name of the campaignstringFilterable, Sortable
MaxLength = 65
startDate Date when the campaign is scheduled to start in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-timeFilterable, Sortable
actualCost Actual cost associated with executing the campaigndoubleFilterable, Sortable
budgetedCost Estimated cost of the campaigndoubleFilterable, Sortable
campaignStatus The campaign status, i.e., the stage of the campaign's activity or progress, e.g., Budgeted, Planned, Approved, etc.stringFilterable, Sortable
campaignStatusId Identifier of the campaign statusuuidFilterable
campaignType Type of the campaign, e.g., Email, Newsletter, Referral Program, Social Media, etc.stringFilterable, Sortable
createdById Identifier of the user who created this objectuuidFilterable
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-timeFilterable, 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 campaignstringFilterable
MaxLength = 50
expectedRevenue Revenue or income expected from the opportunities created via the campaigndoubleFilterable, Sortable
id Object identifieruuidFilterable
lastUpdated Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-timeFilterable, Sortable
lastUpdatedById Identifier of the user who last updated this objectuuidFilterable
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 operationsint32
version Implements concurrency on this objectbyte
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.

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
base_url/crm/campaign

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Campaign

Required Scopes:

read:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
fields Query Specifies the model properties you want in the response bodystring
where Query Specifies only those records that match an expression in the querystring
orderBy Query Specifies the order of the recordsstring
page Query Specifies the page number and number of records on each pagestring
expand Query Specifies the nested model properties you want in the response bodystring
Response Body
NameDescriptionFormat
campaignTypeId Identifier of the campaign typeuuid
endDate Date when the campaign is scheduled to end in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
name Name of the campaignstring
startDate Date when the campaign is scheduled to start in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
actualCost Actual cost associated with executing the campaigndouble
budgetedCost Estimated cost of the campaigndouble
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 statusuuid
campaignType Type of the campaign, e.g., Email, Newsletter, Referral Program, Social Media, etc.string
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-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 campaignstring
expectedRevenue Revenue or income expected from the opportunities created via the campaigndouble
id Object identifieruuid
lastUpdated Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
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 operationsint32
version Implements concurrency on this objectbyte
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.
Example Request
Example Response
[
  {
    "campaignTypeId": "6dce4c3f-8c27-40ca-8552-1858ae394bea",
    "endDate": "2024-01-24T04:16:11Z",
    "name": "Campaign",
    "startDate": "2024-01-24T04:16:11Z",
    "actualCost": 1,
    "budgetedCost": 1,
    "campaignStatus": "campaignStatus",
    "campaignStatusId": "170cbf21-4491-4801-83be-e4fa91098d33",
    "campaignType": "campaignType",
    "createdById": "e83ad69f-94e1-4f2c-8788-c17f4f1755ec",
    "createdOn": "2024-01-24T04:16:11Z",
    "customFields": [
      {
        "definitionId": "2032c043-be89-4652-a17c-70ef372b5932",
        "createdById": "5a65e103-35bc-4582-a2c3-22976628438e",
        "createdOn": "2024-01-24T04:16:11Z",
        "description": "CustomFieldData Description",
        "id": "4ae6b577-2ecd-4c87-be66-74d50bf70586",
        "label": "label",
        "lastUpdated": "2024-01-24T04:16:11Z",
        "lastUpdatedById": "d67473d2-1475-49ac-9a45-0685f59b2f7b",
        "objectState": null,
        "token": 0,
        "type": null,
        "value": "value",
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "expectedResponsePercent": "expectedResponsePercent",
    "expectedRevenue": 1,
    "id": "0c9f4d93-bd64-465e-b756-822d9f2741f0",
    "lastUpdated": "2024-01-24T04:16:11Z",
    "lastUpdatedById": "ca5538c8-d6d2-4808-ba39-ad7147bba8b6",
    "objectState": null,
    "recipients": [
      {
        "campaignId": "96ea1a7e-e8e8-4456-8ee7-5b90f22e1f2c",
        "recipientId": "d3c41a90-497f-4266-bd52-870b5fe73431",
        "recipientType": null,
        "createdById": "0c08cde9-a1d1-437e-a87c-330ee3f6e839",
        "createdOn": "2024-01-24T04:16:11Z",
        "id": "82b7333d-de66-4f3d-a42e-1b86c00567b9",
        "isGroup": true,
        "lastUpdated": "2024-01-24T04:16:11Z",
        "lastUpdatedById": "68522b6b-1d69-47ec-921f-dbed0bea09c7",
        "objectState": null,
        "recipient": "recipient",
        "recipientStatus": null,
        "responded": true,
        "sent": true,
        "token": 0,
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "status": null,
    "token": 0,
    "version": "U3dhZ2dlciByb2Nrcw==",
    "workflow": [
      {
        "actionById": "49cbe3be-c2dd-48c9-bbf9-ff9d23aea44c",
        "action": null,
        "actionBy": "actionBy",
        "createdById": "93882395-f3bb-4716-ad51-c223fefe0c76",
        "createdOn": "2024-01-24T04:16:11Z",
        "date": "2024-01-24T04:16:11Z",
        "id": "57fd9544-0962-4f97-bf98-c1c1932def6d",
        "lastUpdated": "2024-01-24T04:16:11Z",
        "lastUpdatedById": "012a0643-2510-45ed-9bae-a824c16a9188",
        "memo": "memo",
        "objectState": null,
        "sendTo": "sendTo",
        "sendToId": "d4c64c21-9e59-4d33-9cfe-6499618388f0",
        "submitTo": null,
        "token": 0,
        "type": null,
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ]
  }
]

Use this method to retrieve a specific campaign. Pass id as the parameter.

Request URL
base_url/crm/campaign/{id}

Method Overview

HTTP Method:

GET

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Campaign

Required Scopes:

read:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Campaign identifierstring
Response Body
NameDescriptionFormat
campaignTypeId Identifier of the campaign typeuuid
endDate Date when the campaign is scheduled to end in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
name Name of the campaignstring
startDate Date when the campaign is scheduled to start in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
actualCost Actual cost associated with executing the campaigndouble
budgetedCost Estimated cost of the campaigndouble
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 statusuuid
campaignType Type of the campaign, e.g., Email, Newsletter, Referral Program, Social Media, etc.string
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-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 campaignstring
expectedRevenue Revenue or income expected from the opportunities created via the campaigndouble
id Object identifieruuid
lastUpdated Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
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 operationsint32
version Implements concurrency on this objectbyte
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.
Example Request
Example Response
{
  "campaignTypeId": "486b4bbc-bd1d-4a20-8da1-33f5714058d5",
  "endDate": "2024-01-24T04:16:11Z",
  "name": "Campaign",
  "startDate": "2024-01-24T04:16:11Z",
  "actualCost": 1,
  "budgetedCost": 1,
  "campaignStatus": "campaignStatus",
  "campaignStatusId": "abfd4de0-50a2-4cc8-a1b6-21f1bed4a32e",
  "campaignType": "campaignType",
  "createdById": "b3478a60-a002-4586-8d7b-27c6b1c2eedc",
  "createdOn": "2024-01-24T04:16:11Z",
  "customFields": [
    {
      "definitionId": "8b6fd4d1-9ef1-4478-bcdc-b4ac306e5cf6",
      "createdById": "556cf56a-92a4-4663-9f05-6c1b003f553c",
      "createdOn": "2024-01-24T04:16:11Z",
      "description": "CustomFieldData Description",
      "id": "541a51f6-ddb5-48fa-ba3e-a3f2a3e36253",
      "label": "label",
      "lastUpdated": "2024-01-24T04:16:11Z",
      "lastUpdatedById": "7ad54a0c-ef8b-4f1d-ad87-7dec6f421239",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "expectedResponsePercent": "expectedResponsePercent",
  "expectedRevenue": 1,
  "id": "33306ec2-27ea-472b-97d4-361a4017cf65",
  "lastUpdated": "2024-01-24T04:16:11Z",
  "lastUpdatedById": "7580560a-4348-4799-8b56-669cf36d743f",
  "objectState": null,
  "recipients": [
    {
      "campaignId": "de67c65b-126e-4e95-86d3-ee8c57b53de2",
      "recipientId": "a26b0cf6-2b06-4dd8-9860-2f15a8a4a31b",
      "recipientType": null,
      "createdById": "ba838310-a914-464e-8490-d9c247c67d96",
      "createdOn": "2024-01-24T04:16:11Z",
      "id": "161efeac-733b-4aaa-baba-76a6fcdacbf6",
      "isGroup": true,
      "lastUpdated": "2024-01-24T04:16:11Z",
      "lastUpdatedById": "092d7867-d243-442a-abea-c250bafa20d8",
      "objectState": null,
      "recipient": "recipient",
      "recipientStatus": null,
      "responded": true,
      "sent": true,
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "status": null,
  "token": 0,
  "version": "U3dhZ2dlciByb2Nrcw==",
  "workflow": [
    {
      "actionById": "4a0b88e2-3296-4a6a-b8e2-6514a794c90b",
      "action": null,
      "actionBy": "actionBy",
      "createdById": "39db8c2b-c338-4a07-bc0c-887072a4566b",
      "createdOn": "2024-01-24T04:16:11Z",
      "date": "2024-01-24T04:16:11Z",
      "id": "b259b6f3-493b-4e38-84de-2487d7276321",
      "lastUpdated": "2024-01-24T04:16:11Z",
      "lastUpdatedById": "12232245-6dea-4672-8bfd-2a6c4076ea9f",
      "memo": "memo",
      "objectState": null,
      "sendTo": "sendTo",
      "sendToId": "d795414f-1d94-47d1-848f-8032e31ec54f",
      "submitTo": null,
      "token": 0,
      "type": null,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ]
}

Use this method to save a campaign. Pass campaign as the parameter.

Request URL
base_url/crm/campaign

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Campaign

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
body Body Campaign objectCampaign
Response Body
NameDescriptionFormat
campaignTypeId Identifier of the campaign typeuuid
endDate Date when the campaign is scheduled to end in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
name Name of the campaignstring
startDate Date when the campaign is scheduled to start in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
actualCost Actual cost associated with executing the campaigndouble
budgetedCost Estimated cost of the campaigndouble
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 statusuuid
campaignType Type of the campaign, e.g., Email, Newsletter, Referral Program, Social Media, etc.string
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-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 campaignstring
expectedRevenue Revenue or income expected from the opportunities created via the campaigndouble
id Object identifieruuid
lastUpdated Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
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 operationsint32
version Implements concurrency on this objectbyte
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.
Example Request
Example Response
{
  "campaignTypeId": "7b858ef4-ec42-41c1-97a1-7c426852a3ab",
  "endDate": "2024-01-24T04:16:11Z",
  "name": "Campaign",
  "startDate": "2024-01-24T04:16:11Z",
  "actualCost": 1,
  "budgetedCost": 1,
  "campaignStatus": "campaignStatus",
  "campaignStatusId": "f9b9f146-2b4a-4e6f-a1b5-3e892809d285",
  "campaignType": "campaignType",
  "createdById": "9b8598a7-621d-469d-bfd1-30362d8cceee",
  "createdOn": "2024-01-24T04:16:11Z",
  "customFields": [
    {
      "definitionId": "e98e2ae7-5168-41ff-a3f0-1dc7c5b29e70",
      "createdById": "e3223a09-9d61-43c4-8193-6d4349f2057f",
      "createdOn": "2024-01-24T04:16:11Z",
      "description": "CustomFieldData Description",
      "id": "634b4032-2929-494e-8aeb-272be217f6ed",
      "label": "label",
      "lastUpdated": "2024-01-24T04:16:11Z",
      "lastUpdatedById": "6a0b708f-6f03-4074-957c-62842906cbdb",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "expectedResponsePercent": "expectedResponsePercent",
  "expectedRevenue": 1,
  "id": "b1940c28-d87c-4807-886c-d2a92efe58ed",
  "lastUpdated": "2024-01-24T04:16:11Z",
  "lastUpdatedById": "7974e594-df09-4a96-bc05-99afa17964fd",
  "objectState": null,
  "recipients": [
    {
      "campaignId": "a5b02ed4-aab7-4bcb-9705-79fe219bb2b6",
      "recipientId": "85764243-d446-41c7-9a44-5a2bdf829630",
      "recipientType": null,
      "createdById": "5c60f7d2-4394-4ca4-9c4a-816e356e0948",
      "createdOn": "2024-01-24T04:16:11Z",
      "id": "258e6266-d83b-4d8a-a86d-f277a1a51f91",
      "isGroup": true,
      "lastUpdated": "2024-01-24T04:16:11Z",
      "lastUpdatedById": "7e65e88a-1399-4114-9859-465af1e7ed98",
      "objectState": null,
      "recipient": "recipient",
      "recipientStatus": null,
      "responded": true,
      "sent": true,
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "status": null,
  "token": 0,
  "version": "U3dhZ2dlciByb2Nrcw==",
  "workflow": [
    {
      "actionById": "e166cde0-9943-4f84-97b8-097766dfe2de",
      "action": null,
      "actionBy": "actionBy",
      "createdById": "2cb7d8de-4df8-4f53-b916-69beaea69551",
      "createdOn": "2024-01-24T04:16:11Z",
      "date": "2024-01-24T04:16:11Z",
      "id": "c6bb0cb3-bdb7-488c-bb99-6a5b2f9e0b43",
      "lastUpdated": "2024-01-24T04:16:11Z",
      "lastUpdatedById": "11015171-0ea3-43fc-a8f4-2dc4661f2190",
      "memo": "memo",
      "objectState": null,
      "sendTo": "sendTo",
      "sendToId": "03177dd2-6d01-4963-b59f-15016763f0e8",
      "submitTo": null,
      "token": 0,
      "type": null,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ]
}

Use this method to save multiple campaigns. Pass model as the parameter.

Request URL
base_url/crm/campaign/batch

Method Overview

HTTP Method:

POST

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Campaign

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
body Body Campaign objectCampaignBatchRequest
Response Body
NameDescriptionFormat
batchSize Represents the number of entities in a batchint64
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
id Object identifieruuid
lastUpdated Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
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 processedint64
status Represents the status of a job e.g., ready, running, completed, or terminatedstring
token Represents the token for update operationsint32
type Represents the type of a job e.g., create, update, or deletestring
version Implements concurrency on this objectbyte
Example Request
Example Response
{
  "batchSize": 0,
  "createdById": "2a7de8eb-902b-4f5b-9c6c-dfd6ea487bdf",
  "createdOn": "2024-01-24T04:16:11Z",
  "id": "5e2d774d-25fe-4ffb-ad4f-9f270be079cd",
  "lastUpdated": "2024-01-24T04:16:11Z",
  "lastUpdatedById": "58881ce2-4aa0-4fde-b47e-8c1b9f7cc8cc",
  "objectState": null,
  "progress": 0,
  "status": "status",
  "token": 0,
  "type": "type",
  "version": "U3dhZ2dlciByb2Nrcw=="
}

Use this method to update a campaign. Pass id and campaign as the parameters.

Request URL
base_url/crm/campaign/{id}

Method Overview

HTTP Method:

PUT

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Campaign

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Campaign identifierstring
body Body Campaign objectCampaign
Response Body
NameDescriptionFormat
campaignTypeId Identifier of the campaign typeuuid
endDate Date when the campaign is scheduled to end in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
name Name of the campaignstring
startDate Date when the campaign is scheduled to start in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
actualCost Actual cost associated with executing the campaigndouble
budgetedCost Estimated cost of the campaigndouble
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 statusuuid
campaignType Type of the campaign, e.g., Email, Newsletter, Referral Program, Social Media, etc.string
createdById Identifier of the user who created this objectuuid
createdOn Date and time when this object was created (UTC Now), in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-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 campaignstring
expectedRevenue Revenue or income expected from the opportunities created via the campaigndouble
id Object identifieruuid
lastUpdated Last updated date and time value of this object in ISO 8601 date-time format, such as YYYY-MM-DDThh:mm:ssdate-time
lastUpdatedById Identifier of the user who last updated this objectuuid
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 operationsint32
version Implements concurrency on this objectbyte
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.
Example Request
Example Response
{
  "campaignTypeId": "80519b65-2824-4fd7-a4d1-4b12fd172010",
  "endDate": "2024-01-24T04:16:11Z",
  "name": "Campaign",
  "startDate": "2024-01-24T04:16:11Z",
  "actualCost": 1,
  "budgetedCost": 1,
  "campaignStatus": "campaignStatus",
  "campaignStatusId": "ac00a234-d154-4b64-9024-a57a7517f756",
  "campaignType": "campaignType",
  "createdById": "04149d32-7ddd-40a8-a9c8-4ffa14607fd1",
  "createdOn": "2024-01-24T04:16:11Z",
  "customFields": [
    {
      "definitionId": "37f4ef93-882d-4a7b-85b0-a6b2b4c6e828",
      "createdById": "6d9f23fd-e9fb-4da8-8852-2168c8e88b32",
      "createdOn": "2024-01-24T04:16:11Z",
      "description": "CustomFieldData Description",
      "id": "7563c7a0-dbf1-4dc9-9aa2-69b8935a9bd1",
      "label": "label",
      "lastUpdated": "2024-01-24T04:16:11Z",
      "lastUpdatedById": "ff862b09-5710-49c6-a58d-3b2faca69573",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "expectedResponsePercent": "expectedResponsePercent",
  "expectedRevenue": 1,
  "id": "c924abba-505b-4ac4-8894-ba7c1cc4b972",
  "lastUpdated": "2024-01-24T04:16:11Z",
  "lastUpdatedById": "0e8fc5ac-dfcc-4f2a-9d1d-386892a1322a",
  "objectState": null,
  "recipients": [
    {
      "campaignId": "2731cf93-dd7c-4d55-a010-787ba8e5057d",
      "recipientId": "290af908-16ca-44eb-9650-3ac5764a074d",
      "recipientType": null,
      "createdById": "7f7afdd8-eb38-4041-bd37-2edba239cff0",
      "createdOn": "2024-01-24T04:16:11Z",
      "id": "c0a6dc01-b9cd-4fd7-a275-1363b4d60c61",
      "isGroup": true,
      "lastUpdated": "2024-01-24T04:16:11Z",
      "lastUpdatedById": "56fa9d1c-83d5-420d-96f1-649b75fe318d",
      "objectState": null,
      "recipient": "recipient",
      "recipientStatus": null,
      "responded": true,
      "sent": true,
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "status": null,
  "token": 0,
  "version": "U3dhZ2dlciByb2Nrcw==",
  "workflow": [
    {
      "actionById": "b0799fde-606c-45f7-9d7c-32ea03b4ee8e",
      "action": null,
      "actionBy": "actionBy",
      "createdById": "6a7577e3-d795-4fa0-8a7f-15954b4c6dd2",
      "createdOn": "2024-01-24T04:16:11Z",
      "date": "2024-01-24T04:16:11Z",
      "id": "904d0024-2693-4f04-81f8-3690d9704638",
      "lastUpdated": "2024-01-24T04:16:11Z",
      "lastUpdatedById": "ed1240f7-62a3-4a06-9fe5-06c669d92955",
      "memo": "memo",
      "objectState": null,
      "sendTo": "sendTo",
      "sendToId": "a97ef4df-f2a1-44fd-b865-5583cea24213",
      "submitTo": null,
      "token": 0,
      "type": null,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ]
}

Use this method to delete a specific campaign. Pass id as the parameter.

Request URL
base_url/crm/campaign/{id}

Method Overview

HTTP Method:

DELETE

Content Type:

application/json

Response Format:

N/A

Requires Authentication?

Yes

Headers:

Access Token

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Campaign identifierstring
Example Request

Use this method to perform partial modifications to a campaign. Pass id and patch document as parameters.

Request URL
base_url/crm/campaign/{id}

Method Overview

HTTP Method:

PATCH

Content Type:

application/json

Response Format:

json

Requires Authentication?

Yes

Headers:

Access Token

Module:

Campaign

Required Scopes:

readwrite:core

Required Subscription:

View Subscription


Request Parameters asterisk denotes required
NameParameter TypeDescriptionFormat
id Path Campaign identifierstring
body Body A document containing an array of objects with each object representing a single operation to be performedCampaignPatchDocument
Response Body
NameDescriptionFormat
Example Request
Example Response