{"id":"sforce_api_objects_campaignmember","title":"CampaignMember","content":"

CampaignMember

\n
The CampaignMember object represents the relationship between a\n campaign and either a lead or a contact. If the Accounts as Campaign Members setting is enabled\n in an org, CampaignMember can also represent the relationship between a campaign and an\n account.
\n\n
\n

Supported Calls

\n\n \n

create(), delete(),\n describeLayout(), describeSObjects(), getDeleted(), getUpdated(), query(),\n retrieve(), update(),\n upsert()

\n\n
\n\n
\n

Special Access Rules

\n\n \n

Customer Portal users can’t access this object.

\n\n
\n\n
\n

Fields

\n\n \n \n
\n \n \n \n \n \n\n \n\n \n\n \n\n \n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n \n\n \n\n \n\n \n\n
FieldDetails
AccountId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
ID of the account related to the campaign. This field is available only if the\n Accounts as Campaign Members setting is enabled in the org.
\n\n
This field is a relationship field.
\n\n \n \n
Relationship Name
\n\n
Related Record ID
\n\n \n \n
Relationship Type
\n\n
Lookup
\n\n \n \n
Refers To
\n\n
Account
\n\n \n
\n\n
CampaignId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
Required. The ID of the campaign related to the lead or contact.
\n\n
This field is a relationship field.
\n\n \n \n
Relationship Name
\n\n
Campaign
\n\n \n \n
Relationship Type
\n\n
Lookup
\n\n \n \n
Refers To
\n\n
Campaign
\n\n \n
\n\n
City\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The city for the address of the lead or contact. In orgs with the Accounts as Campaign\n Members setting enabled, this field can be the city for the account.
\n\n \n
\n\n
CompanyOrAccount\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The company or account of the lead or contact.
\n\n \n
\n\n
\n ContactId\n \n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Create, Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
Required. The ID of a contact that's related to the campaign.
\n\n
This field is a relationship field.
\n\n \n \n
Relationship Name
\n\n
Contact
\n\n \n \n
Relationship Type
\n\n
Lookup
\n\n \n \n
Refers To
\n\n
Contact
\n\n \n
\n\n
CurrencyIsoCode\n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Create, Defaulted on create, Filter, Group, Nillable, Restricted picklist, Sort,\n Update
\n\n \n \n
Description
\n\n
Available only for organizations with the\n multicurrency feature enabled. This field contains the ISO code for any currency allowed\n by the organization.
\n\n \n
\n\n
Country\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The country for the address of the lead or contact. In orgs with the Accounts as\n Campaign Members setting enabled, this field can be the country for the account.
\n\n \n
\n\n
Description\n
\n \n
Type
\n\n
textarea
\n\n \n \n
Properties
\n\n
Nillable
\n\n \n \n
Description
\n\n
The description of the associated lead or contact. In orgs with the Accounts as\n Campaign Members setting enabled, this field can be the description of the account.
\n\n \n
\n\n
DoNotCall\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
Indicates that the lead or contact doesn’t want to be called. In orgs with the\n Accounts as Campaign Members setting enabled, this field can indicate the account doesn’t\n want to be called.
\n\n \n
\n\n
Email\n
\n \n
Type
\n\n
email
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
Email address for the lead or contact. In orgs with the Accounts as Campaign Members\n setting enabled, this field can be the email address for the account.
\n\n \n
\n\n
Fax\n
\n \n
Type
\n\n
phone
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
Fax number for the lead or contact. In orgs with the Accounts as Campaign Members\n setting enabled, this field can be the fax number for the account.
\n\n \n
\n\n
FirstName\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The first name of the lead or contact.
\n\n \n
\n\n
\n FirstRespondedDate\n \n
\n \n
Type
\n\n
date
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
This field indicates the date that the campaign member received a status of\n Responded.
\n\n \n
\n\n
HasOptedOutOfEmail\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
This field indicates the email opt-out preference for the lead or contact. A value of\n false indicates that the lead or contact is opted\n in to emails. A value of true indicates that they’re\n opted out. In orgs with the Accounts as Campaign Members setting enabled, this field can\n be the opt-out preference for the account email address.
\n\n \n
\n\n
HasOptedOutOfFax\n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
This field indicates the fax opt-out preferences for the lead or contact. A value of\n false indicates that the lead or contact is opted in to receiving faxes. A value of true\n indicates that they’re opted out. In orgs with the Accounts as Campaign Members setting\n enabled, this field can indicate the account has opted out of faxes.
\n\n \n
\n\n
\n HasResponded\n \n
\n \n
Type
\n\n
boolean
\n\n \n \n
Properties
\n\n
Defaulted on create, Filter, Group, Sort
\n\n \n \n
Description
\n\n
This field indicates whether the campaign member has responded to the campaign\n (true) or not (false). Label is Responded.
\n\n \n
\n\n
LastName\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The last name of the lead or contact. The limit is 80 characters.
\n\n \n
\n\n
\n LeadId\n \n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Create, Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
Required. The ID of a lead that's related to the campaign.
\n\n
This field is a relationship field.
\n\n \n \n
Relationship Name
\n\n
Lead
\n\n \n \n
Relationship Type
\n\n
Lookup
\n\n \n \n
Refers To
\n\n
Lead
\n\n \n
\n\n
LeadOrContactId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
\n

The ID of a lead or contact that's related to the campaign. In orgs with the Accounts\n as Campaign Members setting enabled, this field also accepts an account ID.

\n\n
\n\n \n
\n\n
LeadOrContactOwnerId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The ID of the owner of the associated lead or contact owner. In orgs with the Accounts\n as Campaign Members setting enabled, this field can be the owner of the account.
\n\n
This field is a polymorphic relationship field.
\n\n \n \n
Relationship Name
\n\n
LeadOrContactOwner
\n\n \n \n
Relationship Type
\n\n
Lookup
\n\n \n \n
Refers To
\n\n
Group, User
\n\n \n
\n\n
LeadSource\n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The source where the lead was obtained.
\n\n \n
\n\n
MobilePhone\n
\n \n
Type
\n\n
phone
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The mobile phone number of the lead or contact. In orgs with the Accounts as Campaign\n Members setting enabled, this field can be the mobile phone number for the account.
\n\n \n
\n\n
Name\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The first and last name of the lead or contact that's related to the campaign\n member.
\n\n \n
\n\n
Phone\n
\n \n
Type
\n\n
phone
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The phone number of the lead or contact. In orgs with the Accounts as Campaign Members\n setting enabled, this field can be the phone number for the account.
\n\n \n
\n\n
PostalCode\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The postal code for the lead or contact. In orgs with the Accounts as Campaign Members\n setting enabled, this field can be the postal code for the account.
\n\n \n
\n\n
RecordTypeId\n
\n \n
Type
\n\n
reference
\n\n \n \n
Properties
\n\n
Create, Filter, Nillable, Update
\n\n \n \n
Description
\n\n
ID of the record type assigned to this object. To change the record type, modify the\n CampaignMemberRecordTypeId field on the associated Campaign.
\n\n \n
\n\n
Salutation\n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
Salutation for the lead or contact.
\n\n \n
\n\n
State\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The state for the address of the lead or contact. The limit is 80 characters. In orgs\n with the Accounts as Campaign Members setting enabled, this field can be the state of the\n account address.
\n\n \n
\n\n
Status\n
\n \n
Type
\n\n
picklist
\n\n \n \n
Properties
\n\n
Create, Filter, Group, Nillable, Sort, Update
\n\n \n \n
Description
\n\n
Controls the HasResponded flag on this object. You can't directly\n set the HasResponded flag, as it’s read-only. You can set it\n indirectly by setting this field in a create or update call. Each predefined value\n implies a HasResponded flag value. Each time you update this field,\n you implicitly update the HasResponded flag. In the Salesforce user\n interface, Marketing users can define valid status values for the\n Status picklist. They can choose one status as the default status.\n For each Status field value, they can also select which values to\n count as “Responded,” meaning that the HasResponded\n flag is set to true for those values. The limit is\n 40 characters.

When you create or update campaign members, use the text value for\n Status instead of the ID from the CampaignMemberStatus\n object.

\n
\n\n \n
\n\n
Street\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
The street for the address of the lead or contact. In orgs with the Accounts as\n Campaign Members setting enabled, this field can be the street of the account\n address.
\n\n \n
\n\n
Title\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
Title for the lead or contact.
\n\n \n
\n\n
Type\n
\n \n
Type
\n\n
string
\n\n \n \n
Properties
\n\n
Filter, Group, Nillable, Sort
\n\n \n \n
Description
\n\n
Indicates if the campaign member is a lead or a contact. In orgs with the Accounts as\n Campaign Members setting enabled, this field can indicate an account.
\n\n \n
\n\n
\n\n
\n\"Note\"
\n

Note

\n

If you’re importing CampaignMember data into Salesforce and want to set the value for an\n audit field, such as CreatedDate, contact Salesforce. Audit fields are\n automatically updated during API operations unless you request to set these fields\n yourself.

\n
\n
\n\n
\n\n
\n

Usage

\n\n \n

Each record has a unique ID, and must contain either a ContactId or a\n LeadId, but can't contain both. Any attempt to create a single record with\n both results in a successful insert but only the ContactId is inserted.\n However, you can create two separate records on a Campaign—one for the Lead and one for\n the Contact.

\n\n

In orgs with the Accounts as Campaign Members setting enabled, the unique ID can be an\n AccountID.

\n\n
Standard fields from a lead or contact are associated with the CampaignMember object, but you\n can’t query them directly. To include a Phone in your query, for example,\n query the field from the Lead\n object.
SELECT Id, (SELECT Phone FROM Lead)\nFROM CampaignMember
\n
\n\n

This object is defined only for orgs that have the marketing feature and valid marketing\n licenses. If your org doesn’t have the marketing feature or valid marketing licenses, this\n object doesn’t appear in the describeGlobal() call, and you\n can't use describeSObjects() or query() with this object.

\n\n
\n\"Note\"
\n

Note

\n

If you want to track lead-based campaign members you convert to contacts, provide both a\n ContactId and a LeadId. Otherwise, only use one ID type.

\n
\n
\n\n

To issue create() requests to the API, your account only\n requires read access to campaigns.

\n\n

If the record doesn’t exist for the specified ContactId or\n LeadId, then a new record is created. If the record exists, an error is\n returned and no update is made. To update an existing record, specify the ID of the\n CampaignMember record to update.

\n\n

To delete a record, specify the ID of the CampaignMember record.

\n\n

When creating or updating records, the Status field value specified in\n the call is verified as a valid status for the given Campaign:

\n\n \n\n
\n\n
\n

Associated Objects

\n\n \n

This object has the following associated objects. If the API version isn’t specified, they’re\n available in the same API versions as this object. Otherwise, they’re available in the specified\n API version and later.

\n\n
\n \n
\nCampaignMemberChangeEvent (API version 46.0)
\n\n
Change events are available for the object.
\n\n \n
\n\n
\n\n
\n
\n

See Also

\n\n
\n
"}