1. REST API for Oracle Fusion Cloud HCM
  2. Tasks
  3. Campaign Details

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 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 : Campaign Properties
Type: array
Title: Campaign Properties
The campaignProperties resource provides details about campaign properties.
Show Source
Nested Schema : Campaign Categories
Type: array
Title: Campaign Categories
The categories resource creates and retrieves the category associated with a campaign.
Show Source
Nested Schema : External Asset Metrics
Type: array
Title: External Asset Metrics
The CampaignExternalAssetMetricsUIVO resource provides details on external asset metrics for campaigns.
Show Source
Nested Schema : Campaign External Workspaces
Type: array
Title: Campaign External Workspaces
The externalWorkspaces resource provides access to external workspace details for campaigns.
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 : Metrics for Microsoft Teams Messages Associated with a Campaign
Type: array
Title: Metrics for Microsoft Teams Messages Associated with a Campaign
The msTeamsMessageMetrics resource provides details about Microsoft Teams message metrics.
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 : Questionnaire Details
Type: array
Title: Questionnaire Details
The CampQuestionnairesDetailsUIVO resource provides details about campaign questionnaires.
Show Source
Nested Schema : Campaign Questionnaire Metrics
Type: array
Title: Campaign Questionnaire Metrics
The questionnaireMetrics resource provides details about campaign questionnaire metrics.
Show Source
Nested Schema : Campaign Job Requisition Metrics
Type: array
Title: Campaign Job Requisition Metrics
The requisitionMetrics resource provides details on how to retrieve the metrics associated with the requisition of a campaign.
Show Source
Nested Schema : Campaign Requisitions
Type: array
Title: Campaign Requisitions
The requisitions resource provides details on how to create and update the job requisition 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 : Slack Messages Metrics
Type: array
Title: Slack Messages Metrics
The SlackMessageMetrics resource provides details about Slack message performance metrics.
Show Source
Nested Schema : Unified Workspace Channels
Type: array
Title: Unified Workspace Channels
The unifiedWorkspaceChannels resource provides access to campaign workspace channel details.
Show Source
Nested Schema : Campaign Audience Upload Records
Type: array
Title: Campaign Audience Upload Records
The uploadAudiences 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 Asset Contents
Type: array
Title: Campaign Asset Contents
The CampaignAssetContentUIVO resource provides details about campaign asset contents.
Show Source
Nested Schema : Campaign Channel Metrics
Type: array
Title: Campaign Channel Metrics
The assetMetrics resource provides details on 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 : Campaign External Channels
Type: array
Title: Campaign External Channels
The externalChannels resource provides access to external channel details for campaign assets.
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-assetContents-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-assetMetrics-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
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 : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-audienceDetails-metrics-item-post-request
Type: object
Show Source
Nested Schema : schema
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 : schema
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 : schema
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-categories-item-post-request
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-externalAssetMetrices-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Campaign External Channels
Type: array
Title: Campaign External Channels
The channels resource provides access to external communication channels for campaigns.
Show Source
Nested Schema : schema
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 : schema
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-goals-responseMetrics-item-post-request
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-msTeamsMessageMetrics-item-post-request
Type: object
Show Source
Nested Schema : Slack Channel Messages
Type: array
Title: Slack Channel Messages
The SlackChannelMessageMetricsUIVO resource provides details about Slack channel message metrics.
Show Source
Nested Schema : communicateUICampaignDetails-msTeamsMessageMetrics-channelMessages-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Questionnaires
Type: array
Title: Questionnaires
The questionnaires resource provides all the details of a questionnaire, its sections, questions, and the attachments defined.
Show Source
Nested Schema : Campaign Question Labels in the Questionnaire Details
Type: array
Title: Campaign Question Labels in the Questionnaire Details
The CampaignQuestionsVO resource provides details about campaign questions.
Show Source
Nested Schema : communicateUICampaignDetails-questionnaireDetails-questionnaires-item-post-request
Type: object
Show Source
  • Title: In Use
    Maximum Length: 30
    Default Value: N
    Code that shows whether the participants have already responded to the questionnaire.
  • Title: Latest Version
    Maximum Length: 30
    Default Value: N
    Setting that indicates if this is the latest version of the questionnaire. This is a read-only attribute.
  • Title: Maximum Possible Score
    Sum of the maximum possible scores of all questions that are included in the questionnaire.
  • Title: Name
    Maximum Length: 240
    Name of the questionnaire.
  • Title: Questionnaire Code
    Maximum Length: 240
    Alphanumeric code that uniquely identifies a questionnaire defined for a subscriber.
  • Title: Questionnaire ID
    Surrogate identifier of the questionnaire.
  • Title: Questionnaire Version Number
    Default Value: 1
    Version number of the questionnaire. Version Number should be 1 when a new questionnaire is created.
  • Title: Score Questionnaire
    Maximum Length: 30
    Setting that indicates if the questionnaire is scored. This is a read-only attribute.
  • Sections
    Title: Sections
    The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.
Nested Schema : Sections
Type: array
Title: Sections
The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : Questions
Type: array
Title: Questions
The CampaignQuestionsVO resource provides details about campaign questions.
Show Source
Nested Schema : communicateUICampaignDetails-questionnaireDetails-questionnaires-sections-questions-item-post-request
Type: object
Show Source
Nested Schema : Answers
Type: array
Title: Answers
The CampaignQstnAnswersUIVO resource provides details about campaign questionnaire answers.
Show Source
Nested Schema : Questions
Type: array
Title: Questions
The questions resource is a child of the questionnaires resource. It provides details of the questions included in a section of the questionnaire.
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
  • Title: Allow attachments
    Maximum Length: 30
    Default Value: false
    Indicates whether an attachment is allowed as a response to the question.
  • Title: Folder
    Surrogate identifier of the folder where the question is stored.
  • Maximum Length: 4000
    Instructions or additional information for the question.
  • Title: Latest Version
    Maximum Length: 30
    Default Value: N
    Setting that indicates if this is the latest version of the question. This is a read-only attribute.
  • Title: Owner
    Maximum Length: 64
    Person identifier of the person with the privileges to edit the question, if the question is marked as private. Required if question is marked as private.
  • Title: Privacy
    Maximum Length: 30
    Default Value: false
    Indicates whether the question is restricted for edits. A value of true indicates the question is private and the person specified as the owner can edit it.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Code
    Surrogate identifier for the question.
  • Title: Question Text
    Maximum Length: 2000
    Text of the question being asked.
  • Title: Question Type
    Maximum Length: 30
    Default Value: TEXT
    Code identifying the type of question. Valid values are in the list commonLookupsLOV.
  • Title: Question Version Number
    Default Value: 1
    Version number of the question. New questions must have a version number of 1.
  • Title: Response Type
    Default Value: 1
    Surrogate identifier of the response type for the question.
  • Title: Status
    Maximum Length: 30
    Default Value: D
    Status of the question. Valid values are A for Active, I for Inactive and D for Draft.
  • Title: Subscriber
    Surrogate identifier for the subscriber.
Nested Schema : communicateUICampaignDetails-questionnaireDetails-questions-item-post-request
Type: object
Show Source
Nested Schema : Responses from Respondents for the Campaign Questions
Type: array
Title: Responses from Respondents for the Campaign Questions
The CampaignQstnAnswersUIVO resource provides details about campaign questionnaire answers.
Show Source
Nested Schema : communicateUICampaignDetails-questionnaireDetails-questions-answers-item-post-request
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-questionnaireMetrics-item-post-request
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-requisitionMetrics-item-post-request
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : schema
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-slackMessageMetrics-item-post-request
Type: object
Show Source
Nested Schema : Slack Channel Messages
Type: array
Title: Slack Channel Messages
The SlackChannelMessageMetricsUIVO resource provides details about Slack channel message metrics.
Show Source
Nested Schema : communicateUICampaignDetails-slackMessageMetrics-channelMessages-item-post-request
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-unifiedWorkspaceChannels-item-post-request
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-uploadAudiences-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 Asset Metrics
Type: array
Title: Campaign Asset Metrics
The assetMetrics resource provides details on 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 : Campaign Properties
Type: array
Title: Campaign Properties
The campaignProperties resource provides details about campaign properties.
Show Source
Nested Schema : Campaign Categories
Type: array
Title: Campaign Categories
The categories resource creates and retrieves the category associated with a campaign.
Show Source
Nested Schema : External Asset Metrics
Type: array
Title: External Asset Metrics
The CampaignExternalAssetMetricsUIVO resource provides details on external asset metrics for campaigns.
Show Source
Nested Schema : Campaign External Workspaces
Type: array
Title: Campaign External Workspaces
The externalWorkspaces resource provides access to external workspace details for campaigns.
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 : Metrics for Microsoft Teams Messages Associated with a Campaign
Type: array
Title: Metrics for Microsoft Teams Messages Associated with a Campaign
The msTeamsMessageMetrics resource provides details about Microsoft Teams message metrics.
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 : Questionnaire Details
Type: array
Title: Questionnaire Details
The CampQuestionnairesDetailsUIVO resource provides details about campaign questionnaires.
Show Source
Nested Schema : Campaign Questionnaire Metrics
Type: array
Title: Campaign Questionnaire Metrics
The questionnaireMetrics resource provides details about campaign questionnaire metrics.
Show Source
Nested Schema : Campaign Job Requisition Metrics
Type: array
Title: Campaign Job Requisition Metrics
The requisitionMetrics resource provides details on how to retrieve the metrics associated with the requisition of a campaign.
Show Source
Nested Schema : Campaign Requisitions
Type: array
Title: Campaign Requisitions
The requisitions resource provides details on how to create and update the job requisition 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 : Slack Messages Metrics
Type: array
Title: Slack Messages Metrics
The SlackMessageMetrics resource provides details about Slack message performance metrics.
Show Source
Nested Schema : Unified Workspace Channels
Type: array
Title: Unified Workspace Channels
The unifiedWorkspaceChannels resource provides access to campaign workspace channel details.
Show Source
Nested Schema : Campaign Audience Upload Records
Type: array
Title: Campaign Audience Upload Records
The uploadAudiences 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 Asset Contents
Type: array
Title: Campaign Asset Contents
The CampaignAssetContentUIVO resource provides details about campaign asset contents.
Show Source
Nested Schema : Campaign Channel Metrics
Type: array
Title: Campaign Channel Metrics
The assetMetrics resource provides details on 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 : Campaign External Channels
Type: array
Title: Campaign External Channels
The externalChannels resource provides access to external channel details for campaign assets.
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-assetContents-item-response
Type: object
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-externalChannels-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 : communicateUICampaignDetails-assetMetrics-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-audienceDetails-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
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-attachments-item-response
Type: object
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-campaignProperties-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-categories-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-externalAssetMetrices-item-response
Type: object
Show Source
  • Read Only: true
    Unique identifier for the external asset associated with the campaign.
  • Read Only: true
    Maximum Length: 240
    Name of the asset used in the campaign.
  • Read Only: true
    Maximum Length: 30
    Indicates the status of the external asset. Valid values are Active and Inactive. Default is Inactive.
  • Read Only: true
    Maximum Length: 30
    Unique code representing the type of external asset in the campaign.
  • Read Only: true
    Unique identifier for the campaign associated with the external asset metrics.
  • Links
  • Read Only: true
    Indicates whether there are no external users for the campaign asset metrics. Valid values are true and false. Default is false.
  • Read Only: true
    Unique identifier of the parent asset for the campaign external asset metrics.
  • Read Only: true
    Total number of recipients for the campaign's external asset. This metric helps track the reach of the asset.
  • Read Only: true
    Scheduled date for the external asset metrics. This date indicates when the metrics are set to be evaluated or reported.
  • Read Only: true
    Total number of messages sent for the campaign. This metric tracks the count of communications dispatched.
  • Read Only: true
    Number of messages that weren't sent for the campaign.
Nested Schema : communicateUICampaignDetails-externalWorkspaces-item-response
Type: object
Show Source
Nested Schema : Campaign External Channels
Type: array
Title: Campaign External Channels
The channels resource provides access to external communication channels for campaigns.
Show Source
Nested Schema : communicateUICampaignDetails-externalWorkspaces-channels-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-msTeamsMessageMetrics-item-response
Type: object
Show Source
Nested Schema : Metrics for Messages Sent Through Microsoft Teams Channels
Type: array
Title: Metrics for Messages Sent Through Microsoft Teams Channels
The SlackChannelMessageMetricsUIVO resource provides details about Slack channel message metrics.
Show Source
Nested Schema : communicateUICampaignDetails-msTeamsMessageMetrics-channelMessages-item-response
Type: object
Show Source
  • Title: Discussion Summary
    Read Only: true
    Summary of AI-driven discussions for the Microsoft Teams channel message. This attribute provides insights into the key points or themes discussed in the message.
  • Read Only: true
    Unique identifier for the asset associated with the Microsoft Teams channel message.
  • Read Only: true
    Unique identifier for the campaign channel message.
  • Read Only: true
    Maximum Length: 128
    Name of the Microsoft Teams channel where the message was sent.
  • Links
  • Read Only: true
    Maximum Length: 18
    Unique identifier for the message in the Microsoft Teams channel.
  • Read Only: true
    Maximum Length: 255
    Indicates the format in which the message is posted. Valid values are text and HTML. Default is text.
  • Read Only: true
    Maximum Length: 128
    Name of the Microsoft Teams channel where the message was sent.
  • Title: Reactions
    Read Only: true
    Total count of reactions received on the Microsoft Teams channel message.
  • Title: Replies
    Read Only: true
    Total number of replies to the message in the Microsoft Teams channel.
Nested Schema : communicateUICampaignDetails-owners-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-questionnaireDetails-item-response
Type: object
Show Source
Nested Schema : Questionnaires
Type: array
Title: Questionnaires
The questionnaires resource provides all the details of a questionnaire, its sections, questions, and the attachments defined.
Show Source
Nested Schema : Campaign Question Labels in the Questionnaire Details
Type: array
Title: Campaign Question Labels in the Questionnaire Details
The CampaignQuestionsVO resource provides details about campaign questions.
Show Source
Nested Schema : communicateUICampaignDetails-questionnaireDetails-questionnaires-item-response
Type: object
Show Source
  • Title: In Use
    Maximum Length: 30
    Default Value: N
    Code that shows whether the participants have already responded to the questionnaire.
  • Title: Latest Version
    Maximum Length: 30
    Default Value: N
    Setting that indicates if this is the latest version of the questionnaire. This is a read-only attribute.
  • Links
  • Title: Maximum Possible Score
    Sum of the maximum possible scores of all questions that are included in the questionnaire.
  • Title: Name
    Maximum Length: 240
    Name of the questionnaire.
  • Title: Questionnaire Code
    Maximum Length: 240
    Alphanumeric code that uniquely identifies a questionnaire defined for a subscriber.
  • Title: Questionnaire ID
    Surrogate identifier of the questionnaire.
  • Title: Questionnaire Version Number
    Default Value: 1
    Version number of the questionnaire. Version Number should be 1 when a new questionnaire is created.
  • Title: Score Questionnaire
    Maximum Length: 30
    Setting that indicates if the questionnaire is scored. This is a read-only attribute.
  • Sections
    Title: Sections
    The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.
Nested Schema : Sections
Type: array
Title: Sections
The sections resource is a child resource of the questionnaires resource. It provides details of the sections defined in the questionnaire.
Show Source
Nested Schema : communicateUICampaignDetails-questionnaireDetails-questionnaires-sections-item-response
Type: object
Show Source
Nested Schema : Questions
Type: array
Title: Questions
The CampaignQuestionsVO resource provides details about campaign questions.
Show Source
Nested Schema : communicateUICampaignDetails-questionnaireDetails-questionnaires-sections-questions-item-response
Type: object
Show Source
Nested Schema : Answers
Type: array
Title: Answers
The CampaignQstnAnswersUIVO resource provides details about campaign questionnaire answers.
Show Source
Nested Schema : Questions
Type: array
Title: Questions
The questions resource is a child of the questionnaires resource. It provides details of the questions included in a section of the questionnaire.
Show Source
Nested Schema : communicateUICampaignDetails-questionnaireDetails-questionnaires-sections-questions-answers-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-questionnaireDetails-questionnaires-sections-questions-questionDetails-item-response
Type: object
Show Source
  • Title: Allow attachments
    Maximum Length: 30
    Default Value: false
    Indicates whether an attachment is allowed as a response to the question.
  • Title: Folder
    Surrogate identifier of the folder where the question is stored.
  • Maximum Length: 4000
    Instructions or additional information for the question.
  • Title: Latest Version
    Maximum Length: 30
    Default Value: N
    Setting that indicates if this is the latest version of the question. This is a read-only attribute.
  • Links
  • Title: Owner
    Maximum Length: 64
    Person identifier of the person with the privileges to edit the question, if the question is marked as private. Required if question is marked as private.
  • Title: Privacy
    Maximum Length: 30
    Default Value: false
    Indicates whether the question is restricted for edits. A value of true indicates the question is private and the person specified as the owner can edit it.
  • Title: Question Code
    Maximum Length: 240
    Alphanumeric value that uniquely identifies a question defined for a subscriber.
  • Title: Question Code
    Surrogate identifier for the question.
  • Title: Question Text
    Maximum Length: 2000
    Text of the question being asked.
  • Title: Question Type
    Maximum Length: 30
    Default Value: TEXT
    Code identifying the type of question. Valid values are in the list commonLookupsLOV.
  • Title: Question Version Number
    Default Value: 1
    Version number of the question. New questions must have a version number of 1.
  • Title: Response Type
    Default Value: 1
    Surrogate identifier of the response type for the question.
  • Title: Status
    Maximum Length: 30
    Default Value: D
    Status of the question. Valid values are A for Active, I for Inactive and D for Draft.
  • Title: Subscriber
    Surrogate identifier for the subscriber.
Nested Schema : communicateUICampaignDetails-questionnaireDetails-questions-item-response
Type: object
Show Source
Nested Schema : Responses from Respondents for the Campaign Questions
Type: array
Title: Responses from Respondents for the Campaign Questions
The CampaignQstnAnswersUIVO resource provides details about campaign questionnaire answers.
Show Source
Nested Schema : communicateUICampaignDetails-questionnaireDetails-questions-answers-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-questionnaireMetrics-item-response
Type: object
Show Source
  • Read Only: true
    Unique identifier for the campaign associated with the questionnaire metrics.
  • Read Only: true
    Total number of delivered questionnaires for the campaign. This count reflects the number of questionnaires successfully sent to recipients.
  • Links
  • Read Only: true
    Number of individuals who responded to the campaign questionnaire.
  • Read Only: true
    Total number of questionnaires sent for the campaign. This metric helps track the outreach scope.
Nested Schema : communicateUICampaignDetails-requisitionMetrics-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-requisitions-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-selectedLanguages-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-slackMessageMetrics-item-response
Type: object
Show Source
Nested Schema : Slack Channel Messages
Type: array
Title: Slack Channel Messages
The SlackChannelMessageMetricsUIVO resource provides details about Slack channel message metrics.
Show Source
Nested Schema : communicateUICampaignDetails-slackMessageMetrics-channelMessages-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-unifiedWorkspaceChannels-item-response
Type: object
Show Source
Nested Schema : communicateUICampaignDetails-uploadAudiences-item-response
Type: object
Show Source
Links
assetDetails
Parameters:
  • CampaignId: $request.path.CampaignId
The assetDetails resource provides details on how to create and update channels on the campaign.
assetMetrics
Parameters:
  • CampaignId: $request.path.CampaignId
The assetMetrics resource provides details on the metrics associated with one or more channels defined within a campaign.
audienceDetails
Parameters:
  • CampaignId: $request.path.CampaignId
The audienceDetails resource provides details on how to add and update the audience for a campaign.
boAssociation
Parameters:
  • CampaignId: $request.path.CampaignId
The boAssociation resource creates and updates a campaign.
campaignProperties
Parameters:
  • CampaignId: $request.path.CampaignId
The campaignProperties resource provides details about campaign properties.
categories
Parameters:
  • CampaignId: $request.path.CampaignId
The categories resource creates and retrieves the category associated with a campaign.
externalAssetMetrices
Parameters:
  • CampaignId: $request.path.CampaignId
The CampaignExternalAssetMetricsUIVO resource provides details on external asset metrics for campaigns.
externalWorkspaces
Parameters:
  • CampaignId: $request.path.CampaignId
The externalWorkspaces resource provides access to external workspace details for campaigns.
goals
Parameters:
  • CampaignId: $request.path.CampaignId
The goals resource provides details on how to create and update the goals of a campaign.
msTeamsMessageMetrics
Parameters:
  • CampaignId: $request.path.CampaignId
The msTeamsMessageMetrics resource provides details about Microsoft Teams message metrics.
owners
Parameters:
  • CampaignId: $request.path.CampaignId
The owners resource provides details on how to add and update the owners of a campaign.
questionnaireDetails
Parameters:
  • CampaignId: $request.path.CampaignId
The CampQuestionnairesDetailsUIVO resource provides details about campaign questionnaires.
questionnaireMetrics
Parameters:
  • CampaignId: $request.path.CampaignId
The questionnaireMetrics resource provides details about campaign questionnaire metrics.
requisitionMetrics
Parameters:
  • CampaignId: $request.path.CampaignId
The requisitionMetrics resource provides details on how to retrieve the metrics associated with the requisition of a campaign.
requisitions
Parameters:
  • CampaignId: $request.path.CampaignId
The requisitions resource provides details on how to create and update the job requisition of a campaign.
selectedLanguages
Parameters:
  • CampaignId: $request.path.CampaignId
The selectedLanguages resource provides details on how to add and update the languages selected for a campaign.
slackMessageMetrics
Parameters:
  • CampaignId: $request.path.CampaignId
The SlackMessageMetrics resource provides details about Slack message performance metrics.
unifiedWorkspaceChannels
Parameters:
  • CampaignId: $request.path.CampaignId
The unifiedWorkspaceChannels resource provides access to campaign workspace channel details.
uploadAudiences
Parameters:
  • CampaignId: $request.path.CampaignId
The uploadAudiences resource provides details on how to add and update the languages selected for a campaign.
Back to Top