Create a campaign account
post
/crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/CampaignAccounts
Request
Path Parameters
-
CampaignNumber(required): string
The alternate key identifier of the campaign.
Header Parameters
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
-
Upsert-Mode:
Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
AccountId: integer
(int64)
Title:
Campaign Account Party ID
The unique identifier of the account associated with the campaign account. -
CampaignAccountId: integer
(int64)
Title:
Campaign Account ID
The unique identifier of the campaign account. -
CampaignAccountNumber: string
Title:
Campaign Account Number
Maximum Length:30
The alternate key identifier of the campaign account. -
CampaignId: integer
(int64)
Title:
Campaign Identifier
The unique identifier of the campaign. -
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The unique identifier of the campaign to which the campaign account belongs to. -
ErrorDescription: string
Title:
Error Description
Maximum Length:2000
This contains the error message generated during lead generation of this account. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the lead associated with the campaign account. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The unique alternate identifier of the lead associated with the campaign account. -
QueryCriteriaType: string
Title:
Query Criteria Type
Maximum Length:10
Default Value:MANUAL
This indicates whether the account is added by query builder or manually.
Response
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context:
If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
-
REST-Framework-Version:
The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.
Root Schema : campaigns-CampaignAccounts-item-response
Type:
Show Source
object
-
AccountCountry: string
Title:
Country
Read Only:true
The country of the account. -
AccountId: integer
(int64)
Title:
Campaign Account Party ID
The unique identifier of the account associated with the campaign account. -
AccountIndustryClassCode: string
Title:
Primary Industry
Read Only:true
The primary industry class code for the account. -
AccountName: string
Title:
Name
Read Only:true
Maximum Length:360
The name of the account party associated with the campaign account. -
AccountPartyNumber: string
Title:
Registry ID
Read Only:true
Maximum Length:30
The unique alternate identifier of the account associated with the campaign account. -
AccountState: string
Title:
State
Read Only:true
Maximum Length:60
The state of the account. -
AccountTotalEmployees: number
Title:
Company Size
Read Only:true
The total number of employees for the account. -
CampaignAccountId: integer
(int64)
Title:
Campaign Account ID
The unique identifier of the campaign account. -
CampaignAccountNumber: string
Title:
Campaign Account Number
Maximum Length:30
The alternate key identifier of the campaign account. -
CampaignId: integer
(int64)
Title:
Campaign Identifier
The unique identifier of the campaign. -
CampaignNumber: string
Title:
Campaign Number
Maximum Length:30
The unique identifier of the campaign to which the campaign account belongs to. -
CreatedBy: string
Title:
Created By
Read Only:true
Maximum Length:64
The user who created the campaign accounts. -
CreationDate: string
(date-time)
Title:
Creation Date
Read Only:true
The date when the campaign account was created. -
ErrorDescription: string
Title:
Error Description
Maximum Length:2000
This contains the error message generated during lead generation of this account. -
LastUpdateDate: string
(date-time)
Title:
Last Updated
Read Only:true
The date when the campaign account was last updated. -
LastUpdatedBy: string
Title:
Last Updated By
Read Only:true
Maximum Length:64
The user who last updated the campaign account. -
LeadId: integer
(int64)
Title:
Lead ID
The unique identifier of the lead associated with the campaign account. -
LeadName: string
Title:
Lead Name
Read Only:true
Maximum Length:250
The name of the lead associated with the campaign account. -
LeadNumber: string
Title:
Lead Number
Maximum Length:30
The unique alternate identifier of the lead associated with the campaign account. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
QueryCriteriaType: string
Title:
Query Criteria Type
Maximum Length:10
Default Value:MANUAL
This indicates whether the account is added by query builder or manually.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- QueryCriteriaTypeVA
-
Parameters:
- finder:
LookupTypeActiveEnabledOrBindCodeFinder%3BBindLookupType%3DORA_MKT_CAMP_ACNTS_ADD_TYPE
The following properties are defined on the LOV link relation:- Source Attribute: QueryCriteriaType; Target Attribute: LookupCode
- Display Attribute: Meaning
- finder: