Create a campaign sales content
post
/crmRestApi/resources/11.13.18.05/campaigns/{CampaignNumber}/child/SalesContents
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
-
ContentItemId: string
Title:
Content ID
Maximum Length:64
The internal content item identifier from the source system. -
ContentItemName: string
Title:
Content Name
Maximum Length:4000
The name of the sales content item. -
ContentSourceSystem: string
Maximum Length:
50
Default Value:OCE
Indicates from where the content item is sourced. -
DeletedInSourceFlag: boolean
Title:
Content Deleted in Source
Maximum Length:1
Default Value:false
Indicates whether referred sales content item is deleted in source system. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
Indicates the sequence in which the sales content should appear in a page. -
ParentObjectId: integer
(int64)
Title:
Parent Object ID
The unique identifier of the object associated to the sales content row. -
ParentObjectType: string
Maximum Length:
128
The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on. -
PublicContentItemId: string
Title:
Public Content ID
Maximum Length:64
The public content item identifier from the source system. -
PublicContentItemName: string
Title:
Public Content Name
Maximum Length:4000
The name of the public sales content item. -
PublicCustomerName: string
Title:
Customer Name
Maximum Length:4000
The name of the customer for which the public content was published. -
PublicPublishedDate: string
(date-time)
Title:
Publish Date
The date on which the public content item was published. -
PublicStoryLink: string
Title:
Public URL
Maximum Length:4000
The link of the public content item.
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-SalesContents-item-response
Type:
Show Source
object
-
CanDelete: string
Read Only:
true
Default Value:Y
Indicates whether user can delete the content item or not. -
CanUpdate: string
Read Only:
true
Default Value:Y
Indicates whether user can update the content item or not. -
ContentItemId: string
Title:
Content ID
Maximum Length:64
The internal content item identifier from the source system. -
ContentItemName: string
Title:
Content Name
Maximum Length:4000
The name of the sales content item. -
ContentItemType: string
Read Only:
true
Indicates the type of content, for example pdf, png, and so on. -
ContentSourceSystem: string
Maximum Length:
50
Default Value:OCE
Indicates from where the content item is sourced. -
DeletedInSourceFlag: boolean
Title:
Content Deleted in Source
Maximum Length:1
Default Value:false
Indicates whether referred sales content item is deleted in source system. -
DisplaySequence: integer
(int32)
Title:
Display Sequence
Indicates the sequence in which the sales content should appear in a page. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ParentObjectId: integer
(int64)
Title:
Parent Object ID
The unique identifier of the object associated to the sales content row. -
ParentObjectType: string
Maximum Length:
128
The parent object type associated to the sales content row, for example Account, Contact, Lead, and so on. -
PublicContentItemId: string
Title:
Public Content ID
Maximum Length:64
The public content item identifier from the source system. -
PublicContentItemName: string
Title:
Public Content Name
Maximum Length:4000
The name of the public sales content item. -
PublicCustomerName: string
Title:
Customer Name
Maximum Length:4000
The name of the customer for which the public content was published. -
PublicPublishedDate: string
(date-time)
Title:
Publish Date
The date on which the public content item was published. -
PublicStoryLink: string
Title:
Public URL
Maximum Length:4000
The link of the public content item. -
SalesContentId: integer
(int64)
Title:
Sales Content ID
Read Only:true
The unique identifier of the sales content.
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.