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

Name	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

base_url/crm/campaign

/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

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.

Example Response

[
  {
    "campaignTypeId": "8497e22f-262e-4822-953b-c62f212d16a8",
    "endDate": "2024-09-05T05:42:11Z",
    "name": "Campaign",
    "startDate": "2024-09-05T05:42:11Z",
    "actualCost": 1,
    "budgetedCost": 1,
    "campaignStatus": "campaignStatus",
    "campaignStatusId": "7f2b349e-6b95-4f80-b0e8-396860140ead",
    "campaignType": "campaignType",
    "createdById": "58f96086-e319-40aa-8384-a10ec8f0a6f0",
    "createdOn": "2024-09-05T05:42:11Z",
    "customFields": [
      {
        "definitionId": "c081b8cf-ae88-4fbf-993c-a39ce6f358e2",
        "createdById": "8c993f18-09d9-41c6-8d93-7b7ea4c0cacf",
        "createdOn": "2024-09-05T05:42:11Z",
        "description": "CustomFieldData Description",
        "id": "af0b635f-8a4a-4c5a-bd3f-b02611fd6a29",
        "label": "label",
        "lastUpdated": "2024-09-05T05:42:11Z",
        "lastUpdatedById": "f37b02ef-039e-44dc-a24c-88fa32a6df2e",
        "objectState": null,
        "token": 0,
        "type": null,
        "value": "value",
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "expectedResponsePercent": "expectedResponsePercent",
    "expectedRevenue": 1,
    "id": "aef14aac-6fbe-4d11-a5e7-8a92f925a0ff",
    "lastUpdated": "2024-09-05T05:42:11Z",
    "lastUpdatedById": "84ff4108-9561-47c7-8b99-4c81b66d4a31",
    "objectState": null,
    "recipients": [
      {
        "campaignId": "11f92220-f282-4ee2-869a-c75e80c915c6",
        "recipientId": "596a597a-35db-48a6-bb93-68d434303fbe",
        "recipientType": null,
        "createdById": "5a431176-e85f-4da0-8f11-f682c5dbdc02",
        "createdOn": "2024-09-05T05:42:11Z",
        "id": "434177a9-49e0-4cf5-9d5f-835e80674eae",
        "isGroup": true,
        "lastUpdated": "2024-09-05T05:42:11Z",
        "lastUpdatedById": "05f6368e-57cd-4df2-83ab-ae1bba28111c",
        "objectState": null,
        "recipient": "recipient",
        "recipientStatus": null,
        "responded": true,
        "sent": true,
        "token": 0,
        "version": "U3dhZ2dlciByb2Nrcw=="
      }
    ],
    "status": null,
    "token": 0,
    "version": "U3dhZ2dlciByb2Nrcw==",
    "workflow": [
      {
        "actionById": "0789d5e5-c299-4883-8482-cf325169bd8f",
        "action": null,
        "actionBy": "actionBy",
        "createdById": "c1bdd991-9632-4c34-8c5e-1554d15b712a",
        "createdOn": "2024-09-05T05:42:11Z",
        "date": "2024-09-05T05:42:11Z",
        "id": "7228256e-50e7-4cb9-9248-222d67cfb12e",
        "lastUpdated": "2024-09-05T05:42:11Z",
        "lastUpdatedById": "07657337-45cf-4cdd-978c-92d0547ebe5a",
        "memo": "memo",
        "objectState": null,
        "sendTo": "sendTo",
        "sendToId": "d956307b-ca76-4b01-9c37-5ac24a36453a",
        "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

base_url/crm/campaign/{id}

/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

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.

Example Response

{
  "campaignTypeId": "eabb76f6-d24b-4edc-82df-182f6179da18",
  "endDate": "2024-09-05T05:42:11Z",
  "name": "Campaign",
  "startDate": "2024-09-05T05:42:11Z",
  "actualCost": 1,
  "budgetedCost": 1,
  "campaignStatus": "campaignStatus",
  "campaignStatusId": "e9a853f9-5de0-4d48-ace5-83efd155b202",
  "campaignType": "campaignType",
  "createdById": "f7a437a0-5ccd-4ed3-9e11-fd550c60788f",
  "createdOn": "2024-09-05T05:42:11Z",
  "customFields": [
    {
      "definitionId": "be0f4407-9436-47ae-ab07-98480b8c1853",
      "createdById": "5111bfdd-25bc-40fd-abcf-b2027736597c",
      "createdOn": "2024-09-05T05:42:11Z",
      "description": "CustomFieldData Description",
      "id": "71ee5d88-82b7-4794-b852-307694767afa",
      "label": "label",
      "lastUpdated": "2024-09-05T05:42:11Z",
      "lastUpdatedById": "58707d14-2844-4822-936e-9559c7978953",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "expectedResponsePercent": "expectedResponsePercent",
  "expectedRevenue": 1,
  "id": "81b7a6c6-69c5-4379-8ac5-8edb42ae8e2b",
  "lastUpdated": "2024-09-05T05:42:11Z",
  "lastUpdatedById": "e706b48b-5f4c-4360-8262-fa501b96c63a",
  "objectState": null,
  "recipients": [
    {
      "campaignId": "460fbb5e-e1a1-4906-8e99-2fa717c32c37",
      "recipientId": "6e7f35a5-459d-4955-a60a-4104ee8ef9ec",
      "recipientType": null,
      "createdById": "4ae22719-04c0-4ab3-8d47-94cdc4d32110",
      "createdOn": "2024-09-05T05:42:11Z",
      "id": "5dc11408-4342-4eac-a344-89af56173889",
      "isGroup": true,
      "lastUpdated": "2024-09-05T05:42:11Z",
      "lastUpdatedById": "fde7f04b-cf8e-4092-899a-80242a74e5a1",
      "objectState": null,
      "recipient": "recipient",
      "recipientStatus": null,
      "responded": true,
      "sent": true,
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "status": null,
  "token": 0,
  "version": "U3dhZ2dlciByb2Nrcw==",
  "workflow": [
    {
      "actionById": "a137a181-4cca-4c66-bbaa-b334a92fd224",
      "action": null,
      "actionBy": "actionBy",
      "createdById": "2abe6415-1ff4-43e6-ac3b-1ed0d9b6e833",
      "createdOn": "2024-09-05T05:42:11Z",
      "date": "2024-09-05T05:42:11Z",
      "id": "c94faeb5-a8ca-4702-8164-96070301c430",
      "lastUpdated": "2024-09-05T05:42:11Z",
      "lastUpdatedById": "d3c740a3-9110-482d-abd4-fd749418416d",
      "memo": "memo",
      "objectState": null,
      "sendTo": "sendTo",
      "sendToId": "fdd141b5-3b04-461a-9223-5ac06bace436",
      "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

base_url/crm/campaign

/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

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.

Example Response

{
  "campaignTypeId": "d0c1d248-76d3-4177-8a2f-ad9b9754c78c",
  "endDate": "2024-09-05T05:42:11Z",
  "name": "Campaign",
  "startDate": "2024-09-05T05:42:11Z",
  "actualCost": 1,
  "budgetedCost": 1,
  "campaignStatus": "campaignStatus",
  "campaignStatusId": "5b49f386-3392-496f-a72b-e46b644f7cd3",
  "campaignType": "campaignType",
  "createdById": "f7be4714-63fd-4992-8e91-108126bf182a",
  "createdOn": "2024-09-05T05:42:11Z",
  "customFields": [
    {
      "definitionId": "84ffe7a2-1e4e-403d-b552-2e5006c1fc3a",
      "createdById": "4b31afb4-1d35-45a2-9679-55d3df05a3b4",
      "createdOn": "2024-09-05T05:42:11Z",
      "description": "CustomFieldData Description",
      "id": "586908e0-abcb-489a-9d68-acd937e76e7c",
      "label": "label",
      "lastUpdated": "2024-09-05T05:42:11Z",
      "lastUpdatedById": "7a7000ed-535a-4163-9915-81b9fe654e67",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "expectedResponsePercent": "expectedResponsePercent",
  "expectedRevenue": 1,
  "id": "6ab88b2b-4539-46f1-bb3f-e0ddfa54908a",
  "lastUpdated": "2024-09-05T05:42:11Z",
  "lastUpdatedById": "77ec0f08-91d2-4c97-8ae4-294ec6f026aa",
  "objectState": null,
  "recipients": [
    {
      "campaignId": "381b80ac-f8dd-42f2-9d29-4991f2c32ec6",
      "recipientId": "afc6d09b-b120-4e64-a715-b4da89145461",
      "recipientType": null,
      "createdById": "5f0cb3d1-43ea-4edd-b2a4-3f20a8f315bc",
      "createdOn": "2024-09-05T05:42:11Z",
      "id": "43946587-a7f0-4795-9e9d-45af8f9c52aa",
      "isGroup": true,
      "lastUpdated": "2024-09-05T05:42:11Z",
      "lastUpdatedById": "6066289b-ea71-42b7-8541-659b9bd8d195",
      "objectState": null,
      "recipient": "recipient",
      "recipientStatus": null,
      "responded": true,
      "sent": true,
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "status": null,
  "token": 0,
  "version": "U3dhZ2dlciByb2Nrcw==",
  "workflow": [
    {
      "actionById": "24933a26-daaf-444a-9f79-908ae1b89041",
      "action": null,
      "actionBy": "actionBy",
      "createdById": "439525c4-385d-49e7-9c46-bc3731dbc817",
      "createdOn": "2024-09-05T05:42:11Z",
      "date": "2024-09-05T05:42:11Z",
      "id": "fe80fc00-5f7c-48ac-a76c-df847222533c",
      "lastUpdated": "2024-09-05T05:42:11Z",
      "lastUpdatedById": "fef7d436-0cdb-407c-9d71-73300ffa5229",
      "memo": "memo",
      "objectState": null,
      "sendTo": "sendTo",
      "sendToId": "b48c6598-11e6-4936-a071-5b0c46e44b13",
      "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

base_url/crm/campaign/batch

/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

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

Example Response

{
  "batchSize": 0,
  "createdById": "bf3a3bf8-ee86-4feb-aeae-d9d8bff7e8b0",
  "createdOn": "2024-09-05T05:42:11Z",
  "id": "c97c452d-4036-4fd1-91ea-c234e303e733",
  "lastUpdated": "2024-09-05T05:42:11Z",
  "lastUpdatedById": "529d049c-251d-4fac-8fe5-011f436a9b91",
  "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

base_url/crm/campaign/{id}

/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

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.

Example Response

{
  "campaignTypeId": "10fc3583-a4a9-4520-9cfd-89a9d78a33dc",
  "endDate": "2024-09-05T05:42:11Z",
  "name": "Campaign",
  "startDate": "2024-09-05T05:42:11Z",
  "actualCost": 1,
  "budgetedCost": 1,
  "campaignStatus": "campaignStatus",
  "campaignStatusId": "6661085a-ca6f-4f8a-8302-a6584559d488",
  "campaignType": "campaignType",
  "createdById": "588d300a-f747-4b0f-9031-b04020e6c1b4",
  "createdOn": "2024-09-05T05:42:11Z",
  "customFields": [
    {
      "definitionId": "a37f00d9-468d-41f9-9607-03452ce3d896",
      "createdById": "f5493669-3d81-44a7-a2b8-13d3b9c2c818",
      "createdOn": "2024-09-05T05:42:11Z",
      "description": "CustomFieldData Description",
      "id": "687ab98f-8a4c-4e2a-b353-7873a8df108e",
      "label": "label",
      "lastUpdated": "2024-09-05T05:42:11Z",
      "lastUpdatedById": "a9659cf4-8010-414b-bfef-7dd676fdf858",
      "objectState": null,
      "token": 0,
      "type": null,
      "value": "value",
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "expectedResponsePercent": "expectedResponsePercent",
  "expectedRevenue": 1,
  "id": "67404988-a22a-4840-9edf-31a7a156f524",
  "lastUpdated": "2024-09-05T05:42:11Z",
  "lastUpdatedById": "a148727c-2fcf-4cac-9f4a-c4274e92dfbb",
  "objectState": null,
  "recipients": [
    {
      "campaignId": "cc943e13-ff68-444c-a993-38828f076e4b",
      "recipientId": "27eab1af-868e-493e-8d0d-d4758631aa04",
      "recipientType": null,
      "createdById": "d31f41f6-9744-43a0-ad85-bc2f009f29b9",
      "createdOn": "2024-09-05T05:42:11Z",
      "id": "fec9c525-916f-4ca0-8efc-8403fc037f0a",
      "isGroup": true,
      "lastUpdated": "2024-09-05T05:42:11Z",
      "lastUpdatedById": "0f3412b5-669e-4478-b416-fd6abf198d78",
      "objectState": null,
      "recipient": "recipient",
      "recipientStatus": null,
      "responded": true,
      "sent": true,
      "token": 0,
      "version": "U3dhZ2dlciByb2Nrcw=="
    }
  ],
  "status": null,
  "token": 0,
  "version": "U3dhZ2dlciByb2Nrcw==",
  "workflow": [
    {
      "actionById": "910e7cda-60de-41ae-b911-f77be5cc850e",
      "action": null,
      "actionBy": "actionBy",
      "createdById": "0e783bf3-5bdb-486c-8eeb-9acfb5e4e55c",
      "createdOn": "2024-09-05T05:42:11Z",
      "date": "2024-09-05T05:42:11Z",
      "id": "49b5f89b-9a0a-4f80-9fbd-ab6462b4d8c1",
      "lastUpdated": "2024-09-05T05:42:11Z",
      "lastUpdatedById": "50dd61c5-d89d-401c-a55b-3bd439874391",
      "memo": "memo",
      "objectState": null,
      "sendTo": "sendTo",
      "sendToId": "74ba6b0c-4310-4ddb-b987-88bd965a3a98",
      "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

base_url/crm/campaign/{id}

/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

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

base_url/crm/campaign/{id}

/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

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

Campaign

The Campaign Object

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body

Request URL

Method Overview

Request Parameters asterisk denotes required

Request URL

Method Overview

Request Parameters asterisk denotes required

Response Body