Create a campaign

post

/hcmRestApi/resources/11.13.18.05/communicateUICampaignDetails

Request

Header Parameters
  • 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".
  • 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.
  • 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
Request Body - application/json ()
Root Schema : schema
Type: object
Show Source
Nested Schema : Campaign Channel Details
Type: array
Title: Campaign Channel Details
The assetDetails resource provides details on how to create and update channels on the campaign.
Show Source
Nested Schema : Campaign Channel Metrics
Type: array
Title: Campaign Channel Metrics
The assetMetrics resource provides details on how to retrieve the metrics associated with one or more channels defined within a campaign.
Show Source
Nested Schema : Campaign Audience Details
Type: array
Title: Campaign Audience Details
The audienceDetails resource provides details on how to add and update the audience for a campaign.
Show Source
Nested Schema : Campaign Business Object Association
Type: array
Title: Campaign Business Object Association
The boAssociation resource creates and updates a campaign.
Show Source
Nested Schema : Campaigns Goals
Type: array
Title: Campaigns Goals
The goals resource provides details on how to create and update the goals of a campaign.
Show Source
Nested Schema : Campaign Owners
Type: array
Title: Campaign Owners
The owners resource provides details on how to add and update the owners of a campaign.
Show Source
Nested Schema : Campaign Languages
Type: array
Title: Campaign Languages
The selectedLanguages resource provides details on how to add and update the languages selected for a campaign.
Show Source
Nested Schema : communicateUICampaignDetails-assetDetails-item-post-request
Type: object
Show Source
Nested Schema : Campaign Channel Metrics
Type: array
Title: Campaign Channel Metrics
The assetMetrics resource provides details on how to retrieve the metrics associated with one or more channels defined within a campaign.
Show Source
Nested Schema : Campaign Audience Segments
Type: array
Title: Campaign Audience Segments
The audienceSegments resource provides details on how to retrieve the segments associated with one or more channels defined within a campaign.
Show Source
Nested Schema : Grow Notification Metrics
Type: array
Title: Grow Notification Metrics
The notificationMetrics resource provides details on how to retrieve the metrics associated with one or more notification email cycles.
Show Source
Nested Schema : Campaign Banner Details
Type: array
Title: Campaign Banner Details
The postContent resource provides details on how to create and update the banner associated with a post based campaign.
Show Source
Nested Schema : communicateUICampaignDetails-assetDetails-assetMetrics-item-post-request
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-assetDetails-audienceSegments-item-post-request
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-assetDetails-notificationMetrics-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-assetMetrics-item-post-request
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-audienceDetails-item-post-request
Type: object
Show Source
Nested Schema : Campaign Target Audience Details
Type: array
Title: Campaign Target Audience Details
The CampaignAudienceSourceItems resource provides the target audience for a campaign.
Show Source
Nested Schema : Campaign Audience Details Metrics
Type: array
Title: Campaign Audience Details Metrics
The metrics resource retrieves the metrics associated with the audience for a campaign.
Show Source
Nested Schema : communicateUICampaignDetails-audienceDetails-CampaignAudienceSourceItems-item-post-request
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-audienceDetails-metrics-item-post-request
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-boAssociation-item-post-request
Type: object
Show Source
Nested Schema : Campaign Business Object Association Items
Type: array
Title: Campaign Business Object Association Items
The boAssocItems resource retrieves the items associated with the business object association for a campaign.
Show Source
Nested Schema : communicateUICampaignDetails-boAssociation-boAssocItems-item-post-request
Type: object
Show Source
Nested Schema : Campaign Business Object Association Metrics
Type: array
Title: Campaign Business Object Association Metrics
The campaignBoMetrics resource retrieves the metrics associated with the business object association for a campaign.
Show Source
Nested Schema : communicateUICampaignDetails-boAssociation-boAssocItems-campaignBoMetrics-item-post-request
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-goals-item-post-request
Type: object
Show Source
Nested Schema : Campaign Goal Response Choices
Type: array
Title: Campaign Goal Response Choices
The responseChoices resource provides details on how to retrieve the response choices associated with the goals of a campaign.
Show Source
Nested Schema : Campaign Goal Response Metrics
Type: array
Title: Campaign Goal Response Metrics
The responseMetrics resource provides details on how to retrieve the response metrics associated with the goals of a campaign.
Show Source
Nested Schema : communicateUICampaignDetails-goals-responseChoices-item-post-request
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-goals-responseMetrics-item-post-request
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-owners-item-post-request
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-selectedLanguages-item-post-request
Type: object
Show Source
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : communicateUICampaignDetails-item-response
Type: object
Show Source
Nested Schema : Campaign Channel Details
Type: array
Title: Campaign Channel Details
The assetDetails resource provides details on how to create and update channels on the campaign.
Show Source
Nested Schema : Campaign Channel Metrics
Type: array
Title: Campaign Channel Metrics
The assetMetrics resource provides details on how to retrieve the metrics associated with one or more channels defined within a campaign.
Show Source
Nested Schema : Campaign Audience Details
Type: array
Title: Campaign Audience Details
The audienceDetails resource provides details on how to add and update the audience for a campaign.
Show Source
Nested Schema : Campaign Business Object Association
Type: array
Title: Campaign Business Object Association
The boAssociation resource creates and updates a campaign.
Show Source
Nested Schema : Campaigns Goals
Type: array
Title: Campaigns Goals
The goals resource provides details on how to create and update the goals of a campaign.
Show Source
Nested Schema : Campaign Owners
Type: array
Title: Campaign Owners
The owners resource provides details on how to add and update the owners of a campaign.
Show Source
Nested Schema : Campaign Languages
Type: array
Title: Campaign Languages
The selectedLanguages resource provides details on how to add and update the languages selected for a campaign.
Show Source
Nested Schema : communicateUICampaignDetails-assetDetails-item-response
Type: object
Show Source
Nested Schema : Campaign Channel Metrics
Type: array
Title: Campaign Channel Metrics
The assetMetrics resource provides details on how to retrieve the metrics associated with one or more channels defined within a campaign.
Show Source
Nested Schema : Campaign Audience Segments
Type: array
Title: Campaign Audience Segments
The audienceSegments resource provides details on how to retrieve the segments associated with one or more channels defined within a campaign.
Show Source
Nested Schema : Grow Notification Metrics
Type: array
Title: Grow Notification Metrics
The notificationMetrics resource provides details on how to retrieve the metrics associated with one or more notification email cycles.
Show Source
Nested Schema : Campaign Banner Details
Type: array
Title: Campaign Banner Details
The postContent resource provides details on how to create and update the banner associated with a post based campaign.
Show Source
Nested Schema : communicateUICampaignDetails-assetDetails-assetMetrics-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-assetDetails-audienceSegments-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-assetDetails-notificationMetrics-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-assetDetails-postContent-item-response
Type: object
Show Source
Nested Schema : Links
Type: array
Title: Links
The link relations associated with the resource instance.
Show Source
Nested Schema : communicateUICampaignDetails-assetMetrics-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-audienceDetails-item-response
Type: object
Show Source
Nested Schema : Campaign Target Audience Details
Type: array
Title: Campaign Target Audience Details
The CampaignAudienceSourceItems resource provides the target audience for a campaign.
Show Source
Nested Schema : Campaign Audience Details Metrics
Type: array
Title: Campaign Audience Details Metrics
The metrics resource retrieves the metrics associated with the audience for a campaign.
Show Source
Nested Schema : communicateUICampaignDetails-audienceDetails-CampaignAudienceSourceItems-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-audienceDetails-metrics-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-boAssociation-item-response
Type: object
Show Source
Nested Schema : Campaign Business Object Association Items
Type: array
Title: Campaign Business Object Association Items
The boAssocItems resource retrieves the items associated with the business object association for a campaign.
Show Source
Nested Schema : communicateUICampaignDetails-boAssociation-boAssocItems-item-response
Type: object
Show Source
Nested Schema : Campaign Business Object Association Metrics
Type: array
Title: Campaign Business Object Association Metrics
The campaignBoMetrics resource retrieves the metrics associated with the business object association for a campaign.
Show Source
Nested Schema : communicateUICampaignDetails-boAssociation-boAssocItems-campaignBoMetrics-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-goals-item-response
Type: object
Show Source
Nested Schema : Campaign Goal Response Choices
Type: array
Title: Campaign Goal Response Choices
The responseChoices resource provides details on how to retrieve the response choices associated with the goals of a campaign.
Show Source
Nested Schema : Campaign Goal Response Metrics
Type: array
Title: Campaign Goal Response Metrics
The responseMetrics resource provides details on how to retrieve the response metrics associated with the goals of a campaign.
Show Source
Nested Schema : communicateUICampaignDetails-goals-responseChoices-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-goals-responseMetrics-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-owners-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-selectedLanguages-item-response
Type: object
Show Source
Back to Top