swagger: '2.0'
info:
  title: REST API for Oracle Responsys Marketing Cloud Service
  version: 2023.03.03
  description: 'REST API for Oracle Responsys Marketing Cloud Service

    <br /><br /><b> Learn more about Responsys APIs in this video and download the <a href= "https://docs.oracle.com/en/cloud/saas/marketing/responsys-develop/Resources/Responsys_API.pdf">Responsys
    API Brochure</a>.</b><br />


    <iframe width="560" height="315" src="https://www.youtube.com/embed/videoseries?list=PLw7GyH-Hj8cOUEctIQIrl3wIdwsTYqFEx"
    frameborder="0" allowfullscreen="1"></iframe>'
  x-summary: REST API for Oracle Responsys Marketing Cloud Service Learn more about Responsys APIs in
    this video and download the Responsys API Brochure.
paths:
  '/rest/api/v1.3/campaigns/{campaignName}/sms/trigger ':
    post:
      summary: Trigger SMS Message
      operationId: 'post /rest/api/v1.3/campaigns/{campaignName}/sms/trigger '
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/triggerSmsMessage'
      parameters:
      - name: campaignName
        in: path
        description: Campaign Name
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/triggerSmsMessage'
      x-relation:
      - triggerSmsMessage
      produces:
      - application/json
      tags:
      - Trigger SMS Message
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-sms-trigger -post
      x-filename-id: rest-api-v1.3-campaigns-campaignname-sms-trigger-post
  /rest/api/v1.3/user/info:
    get:
      summary: Get User Information
      description: Retrieves information for the user's account sending the request.
      operationId: get /rest/api/v1.3/user/info
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/userInfo'
      produces:
      - application/json
      tags:
      - Account
      x-internal-id: rest-api-v1.3-user-info-get
      x-filename-id: rest-api-v1.3-user-info-get
  /rest/api/v1.3/settings/account:
    get:
      summary: Get Account Settings for a User
      description: Retrieves account settings for the user sending the request.
      operationId: get /rest/api/v1.3/settings/account
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/settings'
      produces:
      - application/json
      tags:
      - Account
      x-internal-id: rest-api-v1.3-settings-account-get
      x-filename-id: rest-api-v1.3-settings-account-get
  /rest/api/v1.3/settings/account/endpoint:
    get:
      summary: Get Endpoint URL for a User
      description: Retrieves the endpoint URL for the user sending the request. The response returns the
        API type and the endpoint URL used to send API requests.
      operationId: get /rest/api/v1.3/settings/account/endpoint
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/endpoint'
      produces:
      - application/json
      tags:
      - Account
      x-internal-id: rest-api-v1.3-settings-account-endpoint-get
      x-filename-id: rest-api-v1.3-settings-account-endpoint-get
  /rest/api/v1.3/settings/account/footer:
    get:
      summary: Get Email Footer
      description: Retrieves the account's Email Footer content. The response returns the footer's text
        and HTML content. <br> See the <a href='https://docs.oracle.com/en/cloud/saas/marketing/responsys-user/index.html#CSHID=SubAccountFooterFiles'>Oracle
        Responsys Help Center</a> for more information.
      operationId: get /rest/api/v1.3/settings/account/footer
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/footer'
      produces:
      - application/json
      tags:
      - Account
      x-internal-id: rest-api-v1.3-settings-account-footer-get
      x-filename-id: rest-api-v1.3-settings-account-footer-get
  /rest/api/v1.3/settings/account/domains/email:
    get:
      summary: Get Email Domain Rules
      description: 'Retrieves a list of Email domain rules for the account. Email domain rules are used
        when campaign messages are being sent out. <br> The response returns: <ul> <li>The domains to
        which campaign messages must not be sent at all</li><li>Domains to which HTML-format campaign
        mssages can be sent with confidence to recipients that will be able to read them</li><li>Domains
        to which only plain-text campaign messages should be sent because recipients cannot read messages
        in any other format</li></ul><br> See the <a href=''https://docs.oracle.com/en/cloud/saas/marketing/responsys-user/index.html#CSHID=EMailDomains''>Oracle
        Responsys Help Center</a> for more information.'
      operationId: get /rest/api/v1.3/settings/account/domains/email
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/domains'
      produces:
      - application/json
      tags:
      - Account
      x-internal-id: rest-api-v1.3-settings-account-domains-email-get
      x-filename-id: rest-api-v1.3-settings-account-domains-email-get
    put:
      summary: Add Email Domain Rules
      description: Adds new email domain rules to existing Email Domain Rules. Email Domain Rules are
        used during Campaign launch.
      operationId: put /rest/api/v1.3/settings/account/domains/email
      responses:
        default:
          description: The response includes a list of email domain rules that exist in the system after
            addition
          schema:
            $ref: '#/definitions/domains'
      produces:
      - application/json
      parameters:
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/addEmailDomainRequest'
      tags:
      - Account
      x-internal-id: rest-api-v1.3-settings-account-domains-email-put
      x-filename-id: rest-api-v1.3-settings-account-domains-email-put
  /rest/api/v1.3/settings/account/domains/email/{domainRuleType}/{domainName}:
    delete:
      summary: Delete Email Domain Rules
      description: Deletes Email Domain Rules.
      operationId: delete /rest/api/v1.3/settings/account/domains/email
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/deleteEmailDomainResponse'
      produces:
      - application/json
      parameters:
      - name: domainRuleType
        in: path
        required: true
        type: string
        enum:
        - avoidDomains
        - htmlDomains
        - txtDomains
        description: 'Domain rule type: avoidDomains, htmlDomains or txtDomains'
      - name: domainName
        in: path
        required: true
        type: string
        description: The domain name to be deleted.
      tags:
      - Account
      x-internal-id: rest-api-v1.3-settings-account-domains-email-{domainRuleType}-{domainName}-delete
      x-filename-id: rest-api-v1.3-settings-account-domains-email-domainruletype-domainname-delete
  /rest/api/v1.3/filters:
    get:
      summary: Retrieve All Filters
      description: Use this endpoint to retrieve all filters for an account. Both simple and classic filters
        are returned in the response.<br><br>For more information on filters, see the <a href='https://docs.oracle.com/en/cloud/saas/marketing/responsys-user/index.html#CSHID=FiltersAndSegmentGroupsLP'>Oracle
        Responsys Help Center</a>.
      operationId: get /rest/api/v1.3/filters
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/filters-collection'
      parameters:
      - name: offset
        in: query
        type: integer
        description: Specifies an offset that allows you to retrieve the next batch of records. Starts
          at 0 and indicates the record number for the response result set. Any positive integer. For
          example, if your limit is 200, specifying an offset of 0 will return records 0 through 200.
          To retrieve the next 200, set an offset of 200. If not specified, the default is 0.
      - name: limit
        in: query
        type: integer
        description: Number of filters to return in the response (defaults to 200 and cannot exceed 200)
      x-relation:
      - instances
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      tags:
      - Filters
      x-internal-id: rest-api-v1.3-filters-get
      x-filename-id: rest-api-v1.3-filters-get
  /rest/api/v1.3/events/{eventName}:
    post:
      summary: Trigger Custom Event
      operationId: post /rest/api/v1.3/events/{eventName}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/triggerEvent-response'
      parameters:
      - name: eventName
        in: path
        description: Event Name
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/triggerCustomEvent'
      x-relation:
      - triggerCustomEvent
      produces:
      - application/json
      tags:
      - Events
      x-internal-id: rest-api-v1.3-events-{eventName}-post
      x-filename-id: rest-api-v1.3-events-eventname-post
  '/rest/api/v1.3/events ':
    get:
      summary: Fetch All the Custom Events
      operationId: get /rest/api/v1.3/events
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/events-collection'
      parameters: []
      x-relation:
      - instances
      produces:
      - application/json
      tags:
      - Events
      x-internal-id: rest-api-v1.3-events -get
      x-filename-id: rest-api-v1.3-events-get
  /rest/api/v1.3/events/rei/{eventName}:
    post:
      summary: Trigger REI Event
      description: Triggers a REI Event for Profile List, App Channel List, and Web Push recipients. Enables
        developers to trigger REI events for users across email, print, and mobile app channels to begin
        Program Orchestration. This feature is only available if it is enabled for your account. To access
        this feature for existing accounts, please log in to <a href='https://support.oracle.com/portal/'>My
        Oracle Support</a> and create a service request.
      operationId: post /rest/api/v1.3/events/rei/{eventName}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/triggerEvent-response'
      parameters:
      - name: eventName
        in: path
        description: Event Name
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/triggerReiEvent'
      x-relation:
      - triggerReiEvent
      produces:
      - application/json
      tags:
      - Events
      x-internal-id: rest-api-v1.3-events-rei-{eventName}-post
      x-filename-id: rest-api-v1.3-events-rei-eventname-post
  /rest/api/v1.3/campaigns/{campaignName}/emailAttachments:
    post:
      summary: Merge Trigger Email With Attachments
      operationId: post /rest/api/v1.3/campaigns/{campaignName}/emailAttachments
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/triggerEmailWithAttachmentsResponse'
      parameters:
      - name: campaignName
        in: path
        description: Campaign Name
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/mergeTriggerEmailWithAttachments'
      x-relation:
      - mergeTriggerEmailWithAttachments
      produces:
      - application/json
      tags:
      - Attachments
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-emailAttachments-post
      x-filename-id: rest-api-v1.3-campaigns-campaignname-emailattachments-post
  /rest/api/v1.3/campaigns/{campaignName}/emailAttachments/actions/trigger:
    post:
      summary: Trigger Email Message with Attachments
      description: Trigger Email Message with attachment data.
      operationId: 'post /rest/api/v1.3/campaigns/{campaignName/emailAttachments/actions/trigger '
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/triggerEmailWithAttachments-response'
      parameters:
      - name: campaignName
        in: path
        description: Campaign Name
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/triggerEmailMessageWithAttachments'
        required: true
      produces:
      - application/json
      tags:
      - Attachments
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-emailAttachments-actions-trigger-post
      x-filename-id: rest-api-v1.3-campaigns-campaignname-emailattachments-actions-trigger-post
  '/rest/api/v1.3/campaigns/{campaignName}/push ':
    post:
      summary: Trigger Push Message
      operationId: 'post /rest/api/v1.3/campaigns/{campaignName}/push '
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/triggerPush-response'
      parameters:
      - name: campaignName
        in: path
        description: Campaign Name
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/triggerPushMessage'
      x-relation:
      - triggerPushMessage
      produces:
      - application/json
      tags:
      - Trigger Push Message
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-push -post
      x-filename-id: rest-api-v1.3-campaigns-campaignname-push-post
  /rest/api/v1.3/campaigns/{campaignName}/email:
    post:
      summary: Merge Trigger Email
      operationId: post /rest/api/v1.3/campaigns/{campaignName}/email
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/triggerEmailResponse'
      parameters:
      - name: campaignName
        in: path
        description: Campaign Name
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/mergeTriggerEmail'
      x-relation:
      - mergeTriggerEmail
      produces:
      - application/json
      tags:
      - Merge Trigger Email
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-email-post
      x-filename-id: rest-api-v1.3-campaigns-campaignname-email-post
  /rest/api/v1.3/campaigns:
    get:
      summary: Fetch All Campaigns
      description: Obtain the campaign properties for all EMD Email, Push, Message Center, SMS, or MMS
        campaigns.
      operationId: get /rest/api/v1.3/campaigns
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/campaigns-collection'
      parameters:
      - name: offset
        in: query
        type: integer
        description: Starts at 0 and indicates the record number for the response result set
      - name: limit
        in: query
        type: integer
        description: Number of campaigns to return in the response (defaults to 200 and cannot exceed
          200)
      - name: type
        in: query
        type: string
        description: The type of campaigns to return in the response (email, push, sms, mms or pushiocampaign,
          defaults to email)
      x-relation:
      - instances
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      tags:
      - Campaigns
      x-internal-id: rest-api-v1.3-campaigns-get
      x-filename-id: rest-api-v1.3-campaigns-get
  /rest/api/v1.3/campaigns/actions/search:
    post:
      summary: Fetch Campaigns using filters
      description: Fetches Campaigns based on search and filter criterias. The results are sorted based
        on the search and filter criteria specified. A maximum of 20 records are returned.
      operationId: post /rest/api/v1.3/campaigns/actions/search
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/searchCampaigns-response'
      parameters:
      - name: searchCampaigns-request-body
        in: body
        description: Search campaign request body contains sections to pass search, filter and sort criterias
        schema:
          $ref: '#/definitions/searchCampaigns-request-body'
      - name: offset
        in: query
        type: integer
        description: Starts at 0 and indicates the record number for the response result set
      - name: limit
        in: query
        type: integer
        description: Number of campaigns to return in the response (defaults to 20 and cannot exceed 20)
      x-relation:
      - instances
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      tags:
      - Campaigns
      x-internal-id: rest-api-v1.3-campaigns-actions-search-post
      x-filename-id: rest-api-v1.3-campaigns-actions-search-post
  /rest/api/v1.3/campaigns/{campaignName}:
    get:
      summary: Fetch A Campaign
      description: Use this interface to get an existing EMD Email campaign object. The response returns
        the campaign object, which includes the campaign ID and the campaign's other properties. The links
        array contains the campaign object's related API operations, specific to the campaign name where
        applicable.
      operationId: get /rest/api/v1.3/campaigns/{campaignName}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/campaigns'
      parameters:
      - name: campaignName
        in: path
        type: string
        description: 'Name of the campaign to be fetched. '
        required: true
      x-relation:
      - instances
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      tags:
      - Campaigns
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-get
      x-filename-id: rest-api-v1.3-campaigns-campaignname-get
  /rest/api/v1.3/campaigns/{campaignName}/preview:
    get:
      summary: Preview a Campaign
      description: Use this endpoint to preview a campaign. The endpoint outputs the campaign in HTML
        and text.
      operationId: get /rest/api/v1.3/campaigns/{campaignName}/preview
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/previewCampaign-response'
      parameters:
      - name: campaignName
        in: path
        required: true
        type: string
        description: Campaign name for preview
      - name: previewType
        in: query
        type: string
        description: This allows you to output only one type of preview. Possible values are html or text.
          By default, both are output.
      - name: listType
        in: query
        type: string
        description: The type of source list you wish to preview. Possible values are ProofList or ProfileList.
          Default value is ProofList.
      - name: riid
        in: query
        type: string
        description: This allows you to preview based on a specific RIID.
      x-relation:
      - instances
      produces:
      - application/json
      tags:
      - Campaigns
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-preview-get
      x-filename-id: rest-api-v1.3-campaigns-campaignname-preview-get
  /rest/api/v1.3/lists/{listName}/members:
    post:
      summary: Merge List Recipients
      operationId: post /rest/api/v1.3/lists/{listName}/members
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/profileListRecipients'
      parameters:
      - name: listName
        in: path
        description: List Name
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/profileListRecipients'
      x-relation:
      - mergeListRecipients
      produces:
      - application/json
      tags:
      - Profile List Recipients
      x-internal-id: rest-api-v1.3-lists-{listName}-members-post
      x-filename-id: rest-api-v1.3-lists-listname-members-post
    get:
      summary: Retrieve List Recipient using query attribute
      description: This endpoint retrieves a count of profile list recipients in a profile list. You can
        use query attributes to filter the results by specifying a query attribute type and values. If
        no query attributes are specified, the total count of profile list recipients is returned. <br><br>
        The <code>count</code> property in the response determines the amount of matching profile list
        recipients.
      operationId: get /rest/api/v1.3/lists/{listName}/members
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/profileListRecipients'
      parameters:
      - name: listName
        in: path
        description: List Name
        type: string
        required: true
      - name: qa
        in: query
        type: string
        description: Query Attribute. Can be either 'r' (RIID_), 'e' (EMAIL_ADDRESS_), 'c' (CUSTOMER_ID_),
          or 'm' (MOBILE_NUMBER_), 'e_md5' (EMAIL_MD5_HASH_), 'e_sha256' (EMAIL_SHA256_HASH_).
      - name: fs
        in: query
        type: string
        description: Comma separated list of fields to retrieve or 'all'
      - name: id
        in: query
        type: string
        description: ID corresponding to the query attribute
      x-relation:
      - retrieveListRecipients
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      tags:
      - Profile List Recipients
      x-internal-id: rest-api-v1.3-lists-{listName}-members-get
      x-filename-id: rest-api-v1.3-lists-listname-members-get
    delete:
      summary: Delete Profile List Recipients using query attribute
      description: Deletes profile list recipients for a profile list using query attributes. Using the
        query parameters specify a query attribute type to identify recipients, and the corresponding
        value. The response indicates how many matching records were deleted. <br> Up to 10 profile list
        recipients can be deleted in a single request.
      operationId: delete /rest/api/v1.3/lists/{listName}/members
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/deleteListRecipientsUsingQueryAttributes'
      parameters:
      - name: listName
        in: path
        description: List Name
        type: string
        required: true
      - name: qa
        in: query
        type: string
        description: Query Attribute. Can be either 'r' (RIID_), 'e' (EMAIL_ADDRESS_), 'c' (CUSTOMER_ID_),
          or 'm' (MOBILE_NUMBER_).
      - name: id
        in: query
        type: string
        description: ID corresponding to the query attribute
      produces:
      - application/json
      tags:
      - Profile List Recipients
      x-internal-id: rest-api-v1.3-lists-{listName}-members-delete
      x-filename-id: rest-api-v1.3-lists-listname-members-delete
  /rest/api/v1.3/lists/{listName}/members/{riid}:
    get:
      summary: Retrieve List Recipient using RIID
      operationId: get /rest/api/v1.3/lists/{listName}/members/{riid}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/profileListRecipients'
      parameters:
      - name: listName
        in: path
        description: List Name
        type: string
        required: true
      - name: riid
        in: path
        description: RIID
        type: string
        required: true
      - name: fs
        in: query
        type: string
        description: Comma separated list of fields to retrieve or 'all'
      x-relation:
      - retrieveListRecipientsRIID
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      tags:
      - Profile List Recipients
      x-internal-id: rest-api-v1.3-lists-{listName}-members-{riid}-get
      x-filename-id: rest-api-v1.3-lists-listname-members-riid-get
    delete:
      summary: Delete List Recipients based on RIID
      description: Deletes List Recipients based on RIID
      operationId: delete /rest/api/v1.3/lists/{listName}/members/{riid}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/profileListRecipients'
      parameters:
      - name: listName
        in: path
        description: List Name
        type: string
        required: true
      - name: riid
        in: path
        description: List Name
        type: string
        required: true
      x-relation:
      - mergeListRecipients
      produces:
      - application/json
      tags:
      - Profile List Recipients
      x-internal-id: rest-api-v1.3-lists-{listName}-members-{riid}-delete
      x-filename-id: rest-api-v1.3-lists-listname-members-riid-delete
  '/rest/api/v1.3/lists/{listName}/members ':
    post:
      summary: Delete multiple Profile List Recipients
      operationId: post /rest/api/v1.3/lists/{listName}/members?action=delete
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/profileListRecipients'
      parameters:
      - name: listName
        in: path
        description: List Name
        type: string
        required: true
      - name: action
        in: query
        type: string
        description: '**action** should have the value **delete**(action=delete).'
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/deleteListRecipientsRequest'
      x-relation:
      - deleteListRecipients
      produces:
      - application/json
      tags:
      - Profile List Recipients
      x-internal-id: rest-api-v1.3-lists-{listName}-members -post
      x-filename-id: rest-api-v1.3-lists-listname-members-post-2
  '/rest/api/v1.3/lists/{listName}/members  ':
    post:
      summary: Retrieve multiple Profile List Recipients
      operationId: post /rest/api/v1.3/lists/{listName}/members?action=get
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/profileListRecipients'
      parameters:
      - name: listName
        in: path
        description: List Name
        type: string
        required: true
      - name: action
        in: query
        type: string
        description: '**action** should have the value **get**(action=get).'
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/retrieveListRecipientsRequest'
      x-relation:
      - retrieveListRecipients
      produces:
      - application/json
      tags:
      - Profile List Recipients
      x-internal-id: rest-api-v1.3-lists-{listName}-members  -post
      x-filename-id: rest-api-v1.3-lists-listname-members-post-3
  /rest/api/v1.3/lists/{listName}/members/count:
    get:
      summary: Retrieve List Recipients Count using query attribute
      description: Retrieves a count of Profile List Recipients that match the query attributes. If no
        query attributes are specified, retrieves total count of the profile list recipients.
      operationId: get /rest/api/v1.3/lists/{listName}/members/count
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/retrieveListRecipientCount'
      parameters:
      - name: listName
        in: path
        description: List Name
        type: string
        required: true
      - name: qa
        in: query
        type: string
        description: 'Query Attribute. Can be one of: <ul><li>''r'' (RIID_)</li><li>''e'' (EMAIL_ADDRESS_)</li><li>''c''
          (CUSTOMER_ID_)</li><li>''m'' (MOBILE_NUMBER_)</li><li>''e_md5'' (EMAIL_MD5_HASH_)</li><li>''e_sha256''
          (EMAIL_SHA256_HASH_)</li></ul>'
      - name: id
        in: query
        type: string
        description: ID corresponding to the query attribute
      produces:
      - application/json
      tags:
      - Profile List Recipients
      x-internal-id: rest-api-v1.3-lists-{listName}-members-count-get
      x-filename-id: rest-api-v1.3-lists-listname-members-count-get
  /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members:
    post:
      summary: Merge Profile Extension Recipients
      description: Merge recipient data into a Profile Extension Table (PET)
      operationId: post /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/profileExtensionRecipients'
      parameters:
      - name: listName
        in: path
        description: List name
        type: string
        required: true
      - name: petName
        in: path
        description: Profile Extension Table (PET) name
        type: string
        required: true
      - name: body
        in: body
        description: Request body
        schema:
          $ref: '#/definitions/profileExtensionRecipients'
      x-relation:
      - mergeProfileExtensionRecipients
      produces:
      - application/json
      tags:
      - Profile Extension Recipients
      x-internal-id: rest-api-v1.3-lists-{listName}-listExtensions-{petName}-members-post
      x-filename-id: rest-api-v1.3-lists-listname-listextensions-petname-members-post
    get:
      summary: Retrieve Profile Extension Recipient using a query attribute
      description: Retrieve Profile Extension Table (PET) recipient data using a query attribute
      operationId: get /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/profileExtensionRecipients'
      parameters:
      - name: listName
        in: path
        description: List name
        type: string
        required: true
      - name: petName
        in: path
        description: Profile Extension Table (PET) name
        type: string
        required: true
      - name: qa
        in: query
        type: string
        description: Query attribute can be either 'r' (RIID_), 'e' (EMAIL_ADDRESS_), 'c' (CUSTOMER_ID_),
          'm' (MOBILE_NUMBER_), or 'd' (MODIFIED_DATE_). The corresponding value passed must match what
          is in the parent Profile List. Note when using 'd' (MODIFIED_DATE_) the corresponding value
          passed as sdate and edate should match what is in the Profile Extension table.
      - name: fs
        in: query
        type: string
        description: Comma separated list of fields to retrieve or 'all'
      - name: id
        in: query
        type: string
        description: ID corresponding to the query attribute, used to locate the record to retrieve
      - name: sdate
        in: query
        type: string
        description: Start date to retrieve modified records. When qa=d, start date should be in MM-DD-YYYY
          format. Retrieves the PET records whose modified date is between the start and the end date.
          Note that the Responsys servers follow Pacific Standard Time (PST) when using this parameter.
      - name: edate
        in: query
        type: string
        description: End date to retrieve modified records. When qa=d, end date should be in MM-DD-YYYY
          format. Retrieves the PET records whose modified date is between the start and the end date.
          Note that the Responsys servers follow Pacific Standard Time (PST) when using this parameter.
      x-relation:
      - retrieveProfileExtensionRecipients
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      tags:
      - Profile Extension Recipients
      x-internal-id: rest-api-v1.3-lists-{listName}-listExtensions-{petName}-members-get
      x-filename-id: rest-api-v1.3-lists-listname-listextensions-petname-members-get
  /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members/{riid}:
    get:
      summary: Retrieve Profile Extension Recipient using an RIID
      description: Retrieve Profile Extension Table (PET) recipient data using the RIID of the parent
        Profile List record
      operationId: get /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members/{riid}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/profileExtensionRecipients'
      parameters:
      - name: listName
        in: path
        description: List name
        type: string
        required: true
      - name: petName
        in: path
        description: Profile Extension Table (PET) name
        type: string
        required: true
      - name: riid
        in: path
        description: RIID of the parent Profile List record, which is used to locate the corresponding
          PET record
        type: string
        required: true
      - name: fs
        in: query
        type: string
        description: Comma separated list of fields to retrieve or 'all'
      x-relation:
      - retrieveProfileExtensionRecipientsRIID
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      tags:
      - Profile Extension Recipients
      x-internal-id: rest-api-v1.3-lists-{listName}-listExtensions-{petName}-members-{riid}-get
      x-filename-id: rest-api-v1.3-lists-listname-listextensions-petname-members-riid-get
    delete:
      summary: Delete Profile Extension Recipient using an RIID
      description: Delete Profile Extension Table (PET) recipient record using the RIID of the parent
        Profile List record
      operationId: delete /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members/{riid}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/profileExtensionRecipients'
      parameters:
      - name: listName
        in: path
        description: List name
        type: string
        required: true
      - name: petName
        in: path
        description: Profile Extension Table (PET) name
        type: string
        required: true
      - name: riid
        in: path
        description: RIID of the parent Profile List record, which is used to locate the corresponding
          PET record
        type: string
        required: true
      x-relation:
      - deleteProfileExtensionRecipientsRIID
      produces:
      - application/json
      tags:
      - Profile Extension Recipients
      x-internal-id: rest-api-v1.3-lists-{listName}-listExtensions-{petName}-members-{riid}-delete
      x-filename-id: rest-api-v1.3-lists-listname-listextensions-petname-members-riid-delete
  '/rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members ':
    post:
      summary: Delete multiple Profile Extension Recipients
      description: Delete multiple Profile Extension Table (PET) recipient records
      operationId: post /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members?action=delete
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/profileExtensionRecipients'
      parameters:
      - name: listName
        in: path
        description: List name
        type: string
        required: true
      - name: petName
        in: path
        description: Profile Extension Table (PET) name
        type: string
        required: true
      - name: action
        in: query
        type: string
        description: '**action** must have the value **delete**(action=delete).'
        required: true
      - name: body
        in: body
        description: Request body
        schema:
          $ref: '#/definitions/deleteListRecipientsRequest'
      x-relation:
      - deleteListRecipients
      produces:
      - application/json
      tags:
      - Profile Extension Recipients
      x-internal-id: rest-api-v1.3-lists-{listName}-listExtensions-{petName}-members -post
      x-filename-id: rest-api-v1.3-lists-listname-listextensions-petname-members-post-2
  '/rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members  ':
    post:
      summary: Retrieve Multiple Profile Extension Recipients
      description: This endpoint is used to retrieve multiple profile extension recipients in an existing
        profile extension table. By supplying an ID for a recipient (for example email address) you can
        retrieve up to 200 recipients in a single request.<br>The request method for this API is <code>POST</code>,
        because the query parameters are passed in the request body. The ids array contains the identifier
        values for the recipients. Values passed in the <code>ids</code> array must correspond to the
        <code>queryAttribute</code> specified. For example, if you specify <code>e</code> for your <code>queryAttribute</code>,
        the system expects the ids array to contain email address values for the records you want to retrieve.
        By specifying field names in the <code>fieldList</code>, you can determine which fields are returned
        for recipients.
      operationId: /rest/api/v1.3/lists/{listName}/listExtensions/{petName}/members?action=get
      responses:
        default:
          description: Bulk Retrieve Profile Extension Recipients
          schema:
            $ref: '#/definitions/profileExtensionRecipients'
      parameters:
      - name: listName
        in: path
        description: The name of the parent profile list for the profile extension table.
        type: string
        required: true
      - name: petName
        in: path
        description: The name of the profile extension table to retrieve recipients.
        type: string
        required: true
      - name: action
        in: query
        type: string
        description: '<b>Required</b>. Must have the value get. For example: <code>?action=get</code>'
        required: true
      - name: body
        in: body
        description: Request body
        schema:
          $ref: '#/definitions/bulkProfileExtensionRecipients'
      x-relation:
      - deleteListRecipients
      produces:
      - application/json
      tags:
      - Profile Extension Recipients
      x-internal-id: rest-api-v1.3-lists-{listName}-listExtensions-{petName}-members  -post
      x-filename-id: rest-api-v1.3-lists-listname-listextensions-petname-members-post-3
  '/rest/api/v1.3/campaigns/{campaignName}/email ':
    post:
      summary: Trigger Email Message
      operationId: 'post /rest/api/v1.3/campaigns/{campaignName}/email '
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/triggerEmail-response'
      parameters:
      - name: campaignName
        in: path
        description: Campaign Name
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/triggerEmailMessage'
      x-relation:
      - triggerEmailMessage
      produces:
      - application/json
      tags:
      - Trigger Email Message
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-email -post
      x-filename-id: rest-api-v1.3-campaigns-campaignname-email-post-2
  /rest/api/v1.3/suppData:
    get:
      summary: Fetch All Supplemental Tables
      description: Use this endpoint to get all Supplemental Tables for your account.
      operationId: get /rest/api/v1.3/suppData
      responses:
        default:
          description: Supplemental Data Tables
          schema:
            $ref: '#/definitions/supp-tables'
      parameters: []
      produces:
      - application/json
      tags:
      - Supplemental Tables
      x-internal-id: rest-api-v1.3-suppData-get
      x-filename-id: rest-api-v1.3-suppdata-get
  /rest/api/v1.3/folders/{folderName}/suppData:
    post:
      summary: Create Supplemental Table
      description: Use this endpoint to create a new supplemental table by providing its schema.
      operationId: post /rest/api/v1.3/folders/{folderName}/suppData
      responses:
        default:
          description: true/false indicating success or failure.
          schema:
            $ref: '#/definitions/supplementalTableResponse'
      parameters:
      - name: folderName
        in: path
        description: Folder Name
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/supplementalTable'
      x-relation:
      - createSupplementalTable
      produces:
      - application/json
      tags:
      - Supplemental Tables
      x-internal-id: rest-api-v1.3-folders-{folderName}-suppData-post
      x-filename-id: rest-api-v1.3-folders-foldername-suppdata-post
  /rest/api/v1.3/folders/{folderName}/suppData/{suppTableName}:
    put:
      summary: Update Supplemental Table
      description: Use this endpoint to update a supplemental table by providing the properties to update.
      operationId: PUT /rest/api/v1.3/folders/{folderName}/suppData/{suppTableName}
      responses:
        default:
          description: Update Supplemental Data Table
          schema:
            $ref: '#/definitions/update-supp-table'
      parameters:
      - name: folderName
        in: path
        description: The name of the folder where the supplemental table is located.
        type: string
        required: true
      - name: suppTableName
        in: path
        description: The name of the supplemental table to update.
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/update-supp-request'
      produces:
      - application/json
      tags:
      - Supplemental Tables
      x-internal-id: rest-api-v1.3-folders-{folderName}-suppData-{suppTableName}-put
      x-filename-id: rest-api-v1.3-folders-foldername-suppdata-supptablename-put
  /rest/api/v1.3/folders:
    get:
      summary: Retrieve Account Folders
      description: Retrieves all folders in your account.
      operationId: get /rest/api/v1.3/folders
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/getFolders-response'
      parameters:
      - name: offset
        in: query
        type: integer
        description: Starts at 0 and indicates the record number for the response result set
      - name: limit
        in: query
        type: integer
        description: Number of folders to return in the response (defaults to 200 and cannot exceed 200)
      x-relation:
      - getFolders
      produces:
      - application/json
      tags:
      - Folders
      x-internal-id: rest-api-v1.3-folders-get
      x-filename-id: rest-api-v1.3-folders-get
    post:
      summary: Create a Folder
      description: Creates a new folder in Oracle Responsys.
      operationId: post /rest/api/v1.3/folders
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/createFolderResponse'
      parameters:
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/createFolderRequest'
      x-relation:
      - createFolder
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - Folders
      x-internal-id: rest-api-v1.3-folders-post
      x-filename-id: rest-api-v1.3-folders-post
  /rest/api/v1.3/folders/{folderName}/content:
    get:
      summary: Retrieve Folder Content
      description: Retrieves the content in a specified folder.
      operationId: get /rest/api/v1.3/folders/{folderName}/content
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/getFolderContent-response'
      parameters:
      - name: folderName
        in: path
        description: Folder Name
        type: string
        required: true
      - name: offset
        in: query
        type: integer
        description: Starts at 0 and indicates the record number for the response result set
      - name: limit
        in: query
        type: integer
        description: Number of objects to return in the response (defaults to 200 and cannot exceed 200)
      x-relation:
      - getFolderContent
      produces:
      - application/json
      tags:
      - Folders
      x-internal-id: rest-api-v1.3-folders-{folderName}-content-get
      x-filename-id: rest-api-v1.3-folders-foldername-content-get
  /rest/api/v1.3/campaigns/{campaignName}/attributes/proofList:
    get:
      summary: Retrieve a Campaign's Proof List
      description: Retrieves the Campaign Proof List associated with a specified Campaign.
      operationId: get /rest/api/v1.3/campaigns/{campaignName}/attributes/proofList
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/campaignProofListAttributeResponse'
      parameters:
      - name: campaignName
        in: path
        description: Name of the Campaign
        type: string
        required: true
      produces:
      - application/json
      tags:
      - Campaign Attributes
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-attributes-proofList-get
      x-filename-id: rest-api-v1.3-campaigns-campaignname-attributes-prooflist-get
    put:
      summary: Update a Campaign's Proof List
      description: Updates the Proof List associated with a Campaign
      operationId: put /rest/api/v1.3/campaigns/{campaignName}/attributes/proofList
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/campaignProofListAttributeResponse'
      parameters:
      - name: campaignName
        in: path
        description: Name of the Campaign
        type: string
        required: true
      - name: body
        description: ''
        in: body
        schema:
          $ref: '#/definitions/campaignProofListAttributeRequest'
        required: true
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - Campaign Attributes
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-attributes-proofList-put
      x-filename-id: rest-api-v1.3-campaigns-campaignname-attributes-prooflist-put
  /rest/api/v1.3/campaigns/{campaignName}/attributes/dataSources:
    get:
      summary: Retrieve Campaign Data Sources
      description: Retrieves Data Sources associated with a Campaign
      operationId: get /rest/api/v1.3/campaigns/{campaignName}/attributes/dataSources
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/campaignDataSourcesAttributeResponse'
      parameters:
      - name: campaignName
        in: path
        description: Name of the Campaign
        type: string
        required: true
      produces:
      - application/json
      tags:
      - Campaign Attributes
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-attributes-dataSources-get
      x-filename-id: rest-api-v1.3-campaigns-campaignname-attributes-datasources-get
  /rest/api/v1.3/lists/{listName}/listExtensions:
    post:
      summary: Create Profile Extension
      operationId: post /rest/api/v1.3/lists/{listName}/listExtensions
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/listExtensions'
      parameters:
      - name: listName
        in: path
        description: List Name
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/listExtensions'
      x-relation:
      - create
      produces:
      - application/json
      tags:
      - List Extensions
      x-internal-id: rest-api-v1.3-lists-{listName}-listExtensions-post
      x-filename-id: rest-api-v1.3-lists-listname-listextensions-post
    get:
      summary: Fetch All Profile Extensions for a Profile List
      operationId: get /rest/api/v1.3/lists/{listName}/listExtensions
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/listExtensions-collection'
      parameters:
      - name: listName
        in: path
        description: List Name
        type: string
        required: true
      x-relation:
      - instances
      produces:
      - application/json
      tags:
      - List Extensions
      x-internal-id: rest-api-v1.3-lists-{listName}-listExtensions-get
      x-filename-id: rest-api-v1.3-lists-listname-listextensions-get
  /rest/api/v1.3/clDocs:
    post:
      summary: Create a Content Library Document
      operationId: post /rest/api/v1.3/clDocs
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/clDocs'
      parameters:
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/clDocs'
      x-relation:
      - createDocument
      produces:
      - application/json
      tags:
      - Content Library Documents
      x-internal-id: rest-api-v1.3-clDocs-post
      x-filename-id: rest-api-v1.3-cldocs-post
  /rest/api/v1.3/clDocs/{docPath}:
    post:
      summary: Update Contents of a Content Library Document
      operationId: post /rest/api/v1.3/clDocs/{docPath}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/clDocs'
      parameters:
      - name: docPath
        in: path
        description: The complete path of the document starting with '/contentlibrary'.
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/clDocs'
      x-relation:
      - setDocumentContent
      produces:
      - application/json
      tags:
      - Content Library Documents
      x-internal-id: rest-api-v1.3-clDocs-{docPath}-post
      x-filename-id: rest-api-v1.3-cldocs-docpath-post
    put:
      summary: Create a copy of a Content Library Document.
      operationId: put /rest/api/v1.3/clDocs/{docPath}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/clDocs'
      parameters:
      - name: docPath
        in: path
        description: ' Destination Document Path'
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/copy-content-request'
      x-relation:
      - CopyDocumentContent
      produces:
      - application/json
      tags:
      - Content Library Documents
      x-internal-id: rest-api-v1.3-clDocs-{docPath}-put
      x-filename-id: rest-api-v1.3-cldocs-docpath-put
    delete:
      summary: Delete a Content Library Document
      operationId: delete /rest/api/v1.3/clDocs/{docPath}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/clDocs'
      parameters:
      - name: docPath
        in: path
        description: The complete path of the document starting with '/contentlibrary'.
        type: string
        required: true
      x-relation:
      - deleteDocument
      produces:
      - application/json
      tags:
      - Content Library Documents
      x-internal-id: rest-api-v1.3-clDocs-{docPath}-delete
      x-filename-id: rest-api-v1.3-cldocs-docpath-delete
    get:
      summary: Retrieve contents of a Content Library Document
      operationId: get /rest/api/v1.3/clDocs/{docPath}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/clDocs'
      parameters:
      - name: docPath
        in: path
        description: The complete path of the document starting with '/contentlibrary'.
        type: string
        required: true
      x-relation:
      - getDocumentContent
      produces:
      - application/json
      tags:
      - Content Library Documents
      x-internal-id: rest-api-v1.3-clDocs-{docPath}-get
      x-filename-id: rest-api-v1.3-cldocs-docpath-get
  /rest/api/v1.3/programs:
    get:
      summary: Fetch All Programs
      operationId: get /rest/api/v1.3/programs
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/programs-collection'
      parameters:
      - name: offset
        in: query
        type: integer
        description: Starts at 0 and indicates the record number for the response result set
      - name: limit
        in: query
        type: integer
        description: Number of programs to return in the response (defaults to 200 and cannot exceed 200)
      - name: status
        in: query
        type: string
        description: Comma separated list of status of programs to be fetched. Allowed values are NOT_RUNNING,RUNNING,RUNNING_WITH_ERRORS
      x-relation:
      - instances
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      tags:
      - Programs
      x-internal-id: rest-api-v1.3-programs-get
      x-filename-id: rest-api-v1.3-programs-get
  /rest/api/v1.3/programs/{programName}:
    get:
      summary: Fetch a Program by Name
      description: Fetches a Program by program name.
      operationId: get /rest/api/v1.3/programs/{programName}
      responses:
        default:
          description: Fetches details for the specified program name.
          schema:
            $ref: '#/definitions/programByName-response'
      parameters:
      - name: programName
        in: path
        type: string
        description: Name of the Program to fetch the details
        required: true
      x-relation:
      - instances
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      tags:
      - Programs
      x-internal-id: rest-api-v1.3-programs-{programName}-get
      x-filename-id: rest-api-v1.3-programs-programname-get
    patch:
      summary: Publish or Unpublish a Program
      description: Use this interface to publish a valid program or unpublish a program.
      operationId: patch /rest/api/v1.3/programs/{programName}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/update-program-response'
      parameters:
      - name: programName
        in: path
        type: string
        description: Name of the Program to be published or unpublished
        required: true
      - name: body
        in: body
        schema:
          $ref: '#/definitions/update-program-request'
      x-relation:
      - instances
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      tags:
      - Programs
      x-internal-id: rest-api-v1.3-programs-{programName}-patch
      x-filename-id: rest-api-v1.3-programs-programname-patch
  /rest/api/v1.3/programs/enactments:
    post:
      summary: Exit Enactments
      description: Moves the enactments at a blocked stage out of a program. In the request body, specify
        the name of the program and the program action (exit).<br><br> In the case of a successful request,
        a success message is returned in the response body. Programs must be currently unpublished, but
        have been published at least once. If these requirements are not met, a 400 Bad Request error
        will be returned. <br> See the <a href='https://docs.oracle.com/en/cloud/saas/marketing/responsys-user/index.html#CSHID=Programs_Analyze'>Oracle
        Responsys Help Center</a> for more information about resolving blocked program stages.
      operationId: post /rest/api/v1.3/programs/enactments
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/exit-program-enactments-response'
      parameters:
      - name: body
        in: body
        schema:
          $ref: '#/definitions/exit-program-enactments-request'
      x-relation:
      - instances
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - Programs
      x-internal-id: rest-api-v1.3-programs-enactments-post
      x-filename-id: rest-api-v1.3-programs-enactments-post
  /rest/api/v1.3/programs/lists/{listName}:
    get:
      summary: Fetch Programs for a Profile List
      description: Fetches all programs associated with the specified profile list. The response includes
        a list of all Programs associated with the Profile List, and information about the program such
        as the status of the program, and the program channels.
      operationId: get /rest/api/v1.3/programs/lists/{listName}
      responses:
        default:
          description: Fetches all programs for the specified Profile List name
          schema:
            $ref: '#/definitions/programs-collection'
      parameters:
      - name: listName
        in: path
        type: string
        description: Profile list name, for which the programs should be fetched
        required: true
      - name: offset
        in: query
        type: integer
        description: Starts at 0 and indicates the record number for the response result set
      - name: limit
        in: query
        type: integer
        description: Number of programs to return in the response (defaults to 200 and cannot exceed 200)
      x-relation:
      - instances
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      tags:
      - Programs
      x-internal-id: rest-api-v1.3-programs-lists-{listName}-get
      x-filename-id: rest-api-v1.3-programs-lists-listname-get
  /rest/api/v1.3/campaigns/{campaignName}/sms:
    post:
      summary: Merge Trigger SMS
      operationId: post /rest/api/v1.3/campaigns/{campaignName}/sms
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/triggerSmsResponse'
      parameters:
      - name: campaignName
        in: path
        description: Campaign Name
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/mergeTriggerSMS'
      x-relation:
      - mergeTriggerSMS
      produces:
      - application/json
      tags:
      - Merge Trigger SMS
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-sms-post
      x-filename-id: rest-api-v1.3-campaigns-campaignname-sms-post
  /rest/api/v1.3/folders/{folderName}/suppData/{tableName}/members:
    post:
      summary: Merge Supplemental Table members with PK
      operationId: post /rest/api/v1.3/folders/{folderName}/suppData/{tableName}/members
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/supplementalTableMemberswithpk'
      parameters:
      - name: folderName
        in: path
        description: Folder name
        type: string
        required: true
      - name: tableName
        in: path
        description: Table Name
        type: string
        required: true
      - name: body
        in: body
        description: Request body
        schema:
          $ref: '#/definitions/supplementalTableMemberswithpk'
      x-relation:
      - mergeTableMembers
      produces:
      - application/json
      tags:
      - Supplemental Table Members
      x-internal-id: rest-api-v1.3-folders-{folderName}-suppData-{tableName}-members-post
      x-filename-id: rest-api-v1.3-folders-foldername-suppdata-tablename-members-post
    get:
      summary: Retrieve Supplemental Table member based on a query attribute
      operationId: get /rest/api/v1.3/folders/{folderName}/suppData/{tableName}/members
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/supplementalTableRecords'
      parameters:
      - name: folderName
        in: path
        description: Folder name
        type: string
        required: true
      - name: tableName
        in: path
        description: Table name
        type: string
        required: true
      - name: qa
        in: query
        type: string
        description: Query attribute. All of the primary key values of the Supplemental Table must be
          specified by repeating this parameter.
      - name: fs
        in: query
        type: string
        description: Comma separated list of fields to retrieve or 'all'
      - name: id
        in: query
        type: string
        description: IDs corresponding to the query attribute. All the primary key values of the Supplemental
          Table must be specified by repeating this parameter. The order of the values must match the
          order of the Primary Keys specified in the 'qa' parameter.
      x-relation:
      - retrieveTableMembers
      consumes:
      - application/x-www-form-urlencoded
      produces:
      - application/json
      tags:
      - Supplemental Table Members
      x-internal-id: rest-api-v1.3-folders-{folderName}-suppData-{tableName}-members-get
      x-filename-id: rest-api-v1.3-folders-foldername-suppdata-tablename-members-get
    delete:
      summary: Delete Supplemental Table member based on a query attribute
      description: Deletes a Supplemental Table member based on a query attribute. A maximum of <b>one</b>
        record is deleted per request.
      operationId: delete /rest/api/v1.3/folders/{folderName}/suppData/{tableName}/members
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/supplementalTableMemberswithpk'
      parameters:
      - name: folderName
        in: path
        description: Folder name
        type: string
        required: true
      - name: tableName
        in: path
        description: Table name
        type: string
        required: true
      - name: qa
        in: query
        type: string
        description: Query attribute. All of the primary key fields of the Supplemental Table must be
          specified by repeating this parameter. Do not include other fields.
      - name: id
        in: query
        type: string
        description: IDs corresponding to the query attribute. All the primary key values of the Supplemental
          Table must be specified by repeating this parameter. The order of the values must match the
          order of the primary keys specified in the 'qa' parameter.
      x-relation:
      - deleteTableMembers
      produces:
      - application/json
      tags:
      - Supplemental Table Members
      x-internal-id: rest-api-v1.3-folders-{folderName}-suppData-{tableName}-members-delete
      x-filename-id: rest-api-v1.3-folders-foldername-suppdata-tablename-members-delete
  '/rest/api/v1.3/folders/{folderName}/suppData/{tableName}/members ':
    post:
      summary: Merge Table Records
      description: This operation is used to merge (update) Supplemental Table records.
      operationId: post /rest/api/v1.3/folders/{folderNam}/suppData/{tableName}/members
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/supplementalTableRecords'
      parameters:
      - name: folderName
        in: path
        description: Folder name
        type: string
        required: true
      - name: tableName
        in: path
        description: Table name
        type: string
        required: true
      - name: body
        in: body
        description: Request body
        schema:
          $ref: '#/definitions/supplementalTableRecords'
      x-relation:
      - mergeTableMembers
      produces:
      - application/json
      tags:
      - Supplemental Table Members
      x-internal-id: rest-api-v1.3-folders-{folderName}-suppData-{tableName}-members -post
      x-filename-id: rest-api-v1.3-folders-foldername-suppdata-tablename-members-post-2
  /rest/api/v1.3/folder/{folderName}/suppData/{suppTableName}:
    get:
      summary: Fetch all the fields or the primary key fields of the Supplemental Table
      operationId: get /rest/api/v1.3/folder/{folderName}/suppData/{suppTableName}
      responses:
        default:
          description: Supplemental Data Tables
          schema:
            $ref: '#/definitions/retrieveSuppFieldsResponse'
      parameters:
      - name: folderName
        in: path
        description: Folder name
        type: string
        required: true
      - name: suppTableName
        in: path
        description: Supplemental Table name
        type: string
        required: true
      - name: ft
        in: query
        description: '**ft=pk** returns only the primary key fields. **ft=all** returns all the fields.
          By default ''ft'' is set to ''all'''
        type: string
        required: false
      produces:
      - application/json
      tags:
      - Supplemental Table Members
      x-internal-id: rest-api-v1.3-folder-{folderName}-suppData-{suppTableName}-get
      x-filename-id: rest-api-v1.3-folder-foldername-suppdata-supptablename-get
  /rest/api/v1.3/campaigns/{campaignName}/schedule:
    post:
      summary: Create an Email or Push campaign schedule
      operationId: post /rest/api/v1.3/campaigns/{campaignName}/schedule
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/create-retrieve-campaignSchedule-response'
      parameters:
      - name: campaignName
        in: path
        description: Campaign Name
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/campaignSchedule'
      x-relation:
      - createSchedule
      produces:
      - application/json
      tags:
      - Email or Push Campaign Schedule
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-schedule-post
      x-filename-id: rest-api-v1.3-campaigns-campaignname-schedule-post
    get:
      summary: Fetch All Email or Push Campaign Schedules
      operationId: get /rest/api/v1.3/campaigns/{campaignName}/schedule
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/campaignSchedule-collection'
      parameters:
      - name: campaignName
        in: path
        description: Campaign Name
        type: string
        required: true
      x-relation:
      - instances
      produces:
      - application/json
      tags:
      - Email or Push Campaign Schedule
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-schedule-get
      x-filename-id: rest-api-v1.3-campaigns-campaignname-schedule-get
  /rest/api/v1.3/campaigns/{campaignName}/schedule/{scheduleId}:
    get:
      summary: Retrieve an Email or Push campaign schedule
      operationId: get /rest/api/v1.3/campaigns/{campaignName}/schedule/{scheduleId}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/create-retrieve-campaignSchedule-response'
      parameters:
      - name: campaignName
        in: path
        description: Campaign Name
        type: string
        required: true
      - name: scheduleId
        in: path
        description: Schedule Id
        type: string
        required: true
      x-relation:
      - getSchedule
      produces:
      - application/json
      tags:
      - Email or Push Campaign Schedule
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-schedule-{scheduleId}-get
      x-filename-id: rest-api-v1.3-campaigns-campaignname-schedule-scheduleid-get
    put:
      summary: Update an Email or Push campaign schedule
      operationId: put /rest/api/v1.3/campaigns/{campaignName}/schedule/{scheduleId}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/update-delete-campaignSchedule-response'
      parameters:
      - name: campaignName
        in: path
        description: Campaign Name
        type: string
        required: true
      - name: scheduleId
        in: path
        description: Schedule Id
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/update-campaignSchedule-request'
      x-relation:
      - updateSchedule
      produces:
      - application/json
      tags:
      - Email or Push Campaign Schedule
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-schedule-{scheduleId}-put
      x-filename-id: rest-api-v1.3-campaigns-campaignname-schedule-scheduleid-put
    delete:
      summary: Delete an Email or Push campaign schedule
      operationId: delete /rest/api/v1.3/campaigns/{campaignName}/schedule/{scheduleId}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/update-delete-campaignSchedule-response'
      parameters:
      - name: campaignName
        in: path
        description: Campaign Name
        type: string
        required: true
      - name: scheduleId
        in: path
        description: Schedule Id
        type: string
        required: true
      x-relation:
      - updateSchedule
      produces:
      - application/json
      tags:
      - Email or Push Campaign Schedule
      x-internal-id: rest-api-v1.3-campaigns-{campaignName}-schedule-{scheduleId}-delete
      x-filename-id: rest-api-v1.3-campaigns-campaignname-schedule-scheduleid-delete
  /rest/api/v1.3/attributes/organizations:
    get:
      summary: Fetch all organizations
      description: Fetch a list of all organizations within the account.
      operationId: get /rest/api/v1.3/attributes/organizations
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/get-organizations-response'
      x-relation:
      - instances
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - Organizations
      x-internal-id: rest-api-v1.3-attributes-organizations-get
      x-filename-id: rest-api-v1.3-attributes-organizations-get
  /rest/api/v1.3/attributes/programs/{programName}:
    get:
      summary: Fetch a program's organization hierarchy
      description: Fetch a list of organizations that can access a program.
      operationId: get /rest/api/v1.3/attributes/programs/{programName}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/get-assigned-attributes-response'
      parameters:
      - name: programName
        in: path
        description: The Program name
        type: string
        required: true
      x-relation:
      - instances
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - Organizations
      x-internal-id: rest-api-v1.3-attributes-programs-{programName}-get
      x-filename-id: rest-api-v1.3-attributes-programs-programname-get
    post:
      summary: Update a program's organizational access
      description: Update the organizations that can access a program.
      operationId: post /rest/api/v1.3/attributes/programs/{programName}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/get-assigned-attributes-response'
      parameters:
      - name: programName
        in: path
        description: The Program name
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/edit-access-attributes-request'
      x-relation:
      - instances
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - Organizations
      x-internal-id: rest-api-v1.3-attributes-programs-{programName}-post
      x-filename-id: rest-api-v1.3-attributes-programs-programname-post
  /rest/api/v1.3/attributes/campaigns/{campaignName}:
    get:
      summary: Fetch a campaign's organization hierarchy
      description: Fetch a list of organizations that can access a campaign.
      operationId: get /rest/api/v1.3/attributes/campaigns/{campaignName}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/get-assigned-attributes-response'
      parameters:
      - name: campaignName
        in: path
        description: The Campaign name
        type: string
        required: true
      x-relation:
      - instances
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - Organizations
      x-internal-id: rest-api-v1.3-attributes-campaigns-{campaignName}-get
      x-filename-id: rest-api-v1.3-attributes-campaigns-campaignname-get
    post:
      summary: Update a campaign's organizational access
      description: Update the organizations that can access a campaign.
      operationId: post /rest/api/v1.3/attributes/campaigns/{campaignName}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/get-assigned-attributes-response'
      parameters:
      - name: campaignName
        in: path
        description: The Campaign name
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/edit-access-attributes-request'
      x-relation:
      - instances
      consumes:
      - application/json
      produces:
      - application/json
      tags:
      - Organizations
      x-internal-id: rest-api-v1.3-attributes-campaigns-{campaignName}-post
      x-filename-id: rest-api-v1.3-attributes-campaigns-campaignname-post
  /rest/api/v1.3/lists:
    get:
      summary: Fetch All Profile Lists
      operationId: get /rest/api/v1.3/lists
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/lists-collection'
      parameters: []
      x-relation:
      - instances
      produces:
      - application/json
      tags:
      - Profile Lists
      x-internal-id: rest-api-v1.3-lists-get
      x-filename-id: rest-api-v1.3-lists-get
    post:
      summary: Create a Profile List with or without brand Context
      operationId: post /rest/api/v1.3/lists
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/createProfileListResponse'
      parameters:
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/createProfileListRequest'
      x-relation:
      - instances
      produces:
      - application/json
      tags:
      - Profile Lists
      x-internal-id: rest-api-v1.3-lists-post
      x-filename-id: rest-api-v1.3-lists-post
  /rest/api/v1.3/lists/{listName}/fields:
    get:
      summary: Retrieve Profile List Fields
      description: Retrieves the fields for the specified profile list. In the request URL, specify the
        name of the profile list to retrieve. A successful response returns a list of the standard and
        custom fields for the list. <br><br> Refer to the <a href='https://docs.oracle.com/en/cloud/saas/marketing/responsys-user/index.html#CSHID=List_SystemFields'>Oracle
        Responsys Help Center</a> for more information about the profile list fields returned in the response.
      operationId: get /rest/api/v1.3/lists/{listName}/fields
      responses:
        default:
          description: List Response
          schema:
            $ref: '#/definitions/profileListFieldsResponse'
      parameters:
      - name: listName
        in: path
        description: List Name
        type: string
        required: true
      produces:
      - application/json
      tags:
      - Profile Lists
      x-internal-id: rest-api-v1.3-lists-{listName}-fields-get
      x-filename-id: rest-api-v1.3-lists-listname-fields-get
  /rest/api/v1.3/lists/{listName}/orgListExtensions/members:
    put:
      summary: Add or Update RIID in the Organizational Scope Mapping
      description: Adds or Updates profile list recipient's RIID in the Organizational Scope Mapping
      operationId: put /rest/api/v1.3/lists/{listName}/orgListExtensions/members
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/mergeOrgListRecipients'
      parameters:
      - name: listName
        in: path
        description: List name
        type: string
        required: true
      - name: body
        in: body
        description: Request body
        schema:
          $ref: '#/definitions/mergeOrgListRecipients'
      x-relation:
      - mergeOrgListRecipients
      produces:
      - application/json
      tags:
      - Profile Lists
      x-internal-id: rest-api-v1.3-lists-{listName}-orgListExtensions-members-put
      x-filename-id: rest-api-v1.3-lists-listname-orglistextensions-members-put
  /rest/api/v1.3/lists/proofLists/records:
    get:
      summary: Retrieve Proof Lists
      description: Retrieves all Proof Lists for an account.
      operationId: get /rest/api/v1.3/lists/proofLists/records
      responses:
        default:
          description: A list of all Proof Lists with their metadata.
          schema:
            $ref: '#/definitions/proofListArray'
      parameters:
      - name: offset
        in: query
        description: offset
        type: integer
        required: false
      - name: limit
        in: query
        description: limit
        type: integer
        required: false
      produces:
      - application/json
      tags:
      - Profile Lists
      x-internal-id: rest-api-v1.3-lists-proofLists-records-get
      x-filename-id: rest-api-v1.3-lists-prooflists-records-get
  /rest/api/v1.3/lists/segmentGroups/records:
    get:
      summary: Retrieve Segment Groups
      description: Retrieves all Segment Groups for an Account
      operationId: get /rest/api/v1.3/lists/segmentGroups/records
      responses:
        default:
          description: A list of all Segment Groups with their metadata.
          schema:
            $ref: '#/definitions/segmentGroupArray'
      parameters:
      - name: offset
        in: query
        description: offset
        type: integer
        required: false
      - name: limit
        in: query
        description: limit
        type: integer
        required: false
      produces:
      - application/json
      tags:
      - Profile Lists
      x-internal-id: rest-api-v1.3-lists-segmentGroups-records-get
      x-filename-id: rest-api-v1.3-lists-segmentgroups-records-get
  /rest/api/v1.3/clFolders:
    post:
      summary: Create Content Library Folder
      operationId: post /rest/api/v1.3/clFolders
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/clFolders'
      parameters:
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/clFolders'
      x-relation:
      - createContentLibraryFolder
      produces:
      - application/json
      tags:
      - Content Library Folders
      x-internal-id: rest-api-v1.3-clFolders-post
      x-filename-id: rest-api-v1.3-clfolders-post
  /rest/api/v1.3/clFolders/{folderPath}:
    delete:
      summary: Delete Content Library Folder
      operationId: delete /rest/api/v1.3/clFolders/{folderPath}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/clFolders'
      parameters:
      - name: folderPath
        in: path
        description: The complete path of the folder starting with /contentlibrary.
        type: string
        required: true
      x-relation:
      - deleteContentLibraryFolder
      tags:
      - Content Library Folders
      x-internal-id: rest-api-v1.3-clFolders-{folderPath}-delete
      x-filename-id: rest-api-v1.3-clfolders-folderpath-delete
    get:
      summary: List contents of a Content Library Folder
      operationId: get /rest/api/v1.3/clFolders/{folderPath}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/listClFoldersResponse'
      parameters:
      - name: folderPath
        in: path
        description: The complete path of the folder starting with /contentlibrary.
        type: string
        required: true
      - name: type
        in: query
        type: string
        description: Specify what content of a folder needs to be listed. Allowed values are 'all', 'folders',
          'docs' or 'items'. Defaults to 'all'
      x-relation:
      - listContentLibraryFolders
      consumes:
      - application/x-www-form-urlencoded
      tags:
      - Content Library Folders
      x-internal-id: rest-api-v1.3-clFolders-{folderPath}-get
      x-filename-id: rest-api-v1.3-clfolders-folderpath-get
  /rest/api/v1.3/clDocImages/{documentPath}:
    post:
      summary: Update content of images in a Content Library Document
      operationId: post /rest/api/v1.3/clDocImages/{documentPath}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/clDocImages'
      parameters:
      - name: documentPath
        in: path
        description: The complete path of the document starting with '/contentlibrary'.
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/clDocImages'
      x-relation:
      - setDocumentImages
      produces:
      - application/json
      tags:
      - Content Library Document Images
      x-internal-id: rest-api-v1.3-clDocImages-{documentPath}-post
      x-filename-id: rest-api-v1.3-cldocimages-documentpath-post
    get:
      summary: Retrieve binary content of images in a Content Library Document
      operationId: get /rest/api/v1.3/clDocImages/{documentPath}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/clDocImages'
      parameters:
      - name: documentPath
        in: path
        description: The complete path of the document starting with '/contentlibrary'.
        type: string
        required: true
      x-relation:
      - getDocumentImages
      produces:
      - application/json
      tags:
      - Content Library Document Images
      x-internal-id: rest-api-v1.3-clDocImages-{documentPath}-get
      x-filename-id: rest-api-v1.3-cldocimages-documentpath-get
  /rest/api/v1.3/clItems/{itemPath}:
    post:
      summary: Update a Content Library Media File
      operationId: post /rest/api/v1.3/clItems/{itemPath}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/clItems'
      parameters:
      - name: itemPath
        in: path
        description: The complete path of the media file starting with /contentlibrary.
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/clItems'
      x-relation:
      - setContentLibraryItem
      produces:
      - application/json
      tags:
      - Content Library Media Items
      x-internal-id: rest-api-v1.3-clItems-{itemPath}-post
      x-filename-id: rest-api-v1.3-clitems-itempath-post
    delete:
      summary: Delete a Content Library Media File
      operationId: delete /rest/api/v1.3/clItems/{itemPath}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/clItems'
      parameters:
      - name: itemPath
        in: path
        description: The complete path of the media file starting with /contentlibrary.
        type: string
        required: true
      x-relation:
      - deleteContentLibraryItem
      produces:
      - application/json
      tags:
      - Content Library Media Items
      x-internal-id: rest-api-v1.3-clItems-{itemPath}-delete
      x-filename-id: rest-api-v1.3-clitems-itempath-delete
    get:
      summary: Retrieve contents of a Content Library Media File
      operationId: get /rest/api/v1.3/clItems/{itemPath}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/clItems'
      parameters:
      - name: itemPath
        in: path
        description: The complete path of the media file starting with /contentlibrary.
        type: string
        required: true
      x-relation:
      - getContentLibraryItem
      produces:
      - application/json
      tags:
      - Content Library Media Items
      x-internal-id: rest-api-v1.3-clItems-{itemPath}-get
      x-filename-id: rest-api-v1.3-clitems-itempath-get
  /rest/api/v1.3/clItems:
    post:
      summary: Create a Content Library Media File
      description: This operation is used to create a content library media file.
      operationId: post /rest/api/v1.3/clItems
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/clItems'
      parameters:
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/clItems'
      x-relation:
      - setContentLibraryItem
      produces:
      - application/json
      tags:
      - Content Library Media Items
      x-internal-id: rest-api-v1.3-clItems-post
      x-filename-id: rest-api-v1.3-clitems-post
  '/rest/api/v1.3/clItems/{destinationItemPath} ':
    put:
      summary: Create a copy of a Content Library Media file.
      description: This operation is used to create a copy of a Content Library Media file.
      operationId: post /rest/api/v1.3/clItems/{destinationItemPath}
      responses:
        default:
          description: ''
          schema:
            $ref: '#/definitions/clItems'
      parameters:
      - name: destinationItemPath
        in: path
        description: The complete path of the media file starting with /contentlibrary.
        type: string
        required: true
      - name: body
        in: body
        description: Request Body
        schema:
          $ref: '#/definitions/copy-contentItem-request'
      x-relation:
      - setContentLibraryItem
      produces:
      - application/json
      tags:
      - Content Library Media Items
      x-internal-id: rest-api-v1.3-clItems-{destinationItemPath} -put
      x-filename-id: rest-api-v1.3-clitems-destinationitempath-put
definitions:
  triggerSmsMessage:
    title: Trigger SMS Message
    type: object
    properties:
      recipientData:
        description: Array of Recipients with Optional Data
        type: array
        items:
          type: object
          properties:
            recipient:
              type: object
              description: Information about the Recipient.
              properties:
                customerId:
                  type: string
                  description: Recipient's Customer ID.
                mobileNumber:
                  type: string
                  description: Recipient's Mobile Number.
                emailAddress:
                  type: string
                  description: Recipient's Email Address.
                emailMD5Hash:
                  type: string
                  description: Recipient's MD5 Email Hash Value.
                emailSHA256Hash:
                  type: string
                  description: Recipient's SHA256 Email Hash Value.
                listName:
                  type: object
                  description: Profile List to which the Recipient belongs.
                  properties:
                    folderName:
                      type: string
                      description: Folder Name
                    objectName:
                      type: string
                      description: Profile List Name.
                recipientId:
                  type: number
                  description: Recipient's RIID.
              required:
              - customerId
              - emailAddress
              - listName
              - recipientId
              - mobileNumber
            optionalData:
              type: array
              description: Array of optional data containing name value pairs.
              items:
                type: object
                properties:
                  name:
                    type: string
                  value:
                    type: string
          required:
          - recipient
          - optionalData
    required:
    - recipientData
  triggerSms-response:
    title: Trigger SMS Response
    type: array
    description: Array of Recipient Results.
    items:
      type: object
      description: Response for individual recipient.
      properties:
        errorMessage:
          type: string
          description: Error Message, if any, that occurred during the trigger operation.
        success:
          type: boolean
          description: Indicates success or failure.
        recipientId:
          type: number
          description: The Responsys ID (RIID) of the recipient.
  userInfo:
    title: User Information
    type: object
    properties:
      accountName:
        description: Account name.
        type: string
      userName:
        description: Username.
        type: string
      userEmail:
        description: Email Address of the user.
        type: string
      userLocale:
        description: Locale of the user.
        type: string
      accountDisplayName:
        description: Account display name.
        type: string
      accountTimeZone:
        description: Account time zone.
        type: string
      createdDate:
        description: User Creation Date.
        type: string
    required:
    - accountName
    - userName
    - userEmail
    - userLocale
    - accountDisplayName
    - accountTimeZone
    - createdDate
  settings:
    title: Account Settings
    type: object
    properties:
      name:
        description: Username
        type: string
      endpoint:
        description: The endpoint URL assciated with Auth Token.
        type: string
      fileSystemLocation:
        description: Path to the file system location associated with the account.
        type: string
      includedImages:
        description: List of URLs to included images.
        type: array
        items:
          type: string
          description: URL path to included image.
      unsubscribeHandler:
        description: URL to Unsubscribe Handler
        type: string
    required:
    - name
    - endpoint
    - fileSystemLocation
    - includedImages
    - unsubscribeHandler
  endpoint:
    title: Account Endpoints
    type: object
    properties:
      apiType:
        description: The API type to which the endpoint sends the API requests.
        type: string
        enum:
        - rest
        - soap
      endPoint:
        description: The endpoint URL associated with the Auth Token which is used to send API requests
          to the API type.
        type: string
    required:
    - apiType
    - endPoint
  footer:
    title: Email Footer
    type: object
    properties:
      text:
        description: Contents of the Text Footer
        type: string
      html:
        description: Contents of the HTML Footer
        type: string
    required:
    - text
    - html
  domains:
    title: Email Domain Rules
    type: object
    properties:
      avoidDomains:
        description: List of email domains to which campaign messages must not be sent at all
        type: string
      htmlDomains:
        description: List of domains that support only HTML based emails
        type: string
      txtDomains:
        description: List of domains that support only text based emails
        type: string
    required:
    - avoidDomains
    - htmlDomains
    - txtDomains
  addEmailDomainRequest:
    title: Add Email Domain Rules Request
    type: object
    properties:
      avoidDomains:
        description: List of email domains to which campaign messages must not be sent at all.
        type: array
        items:
          type: string
      htmlDomains:
        description: List of domains that support only HTML based emails.
        type: array
        items:
          type: string
      txtDomains:
        description: List of domains that support only text based emails.
        type: array
        items:
          type: string
    required:
    - avoidDomains
    - htmlDomains
    - txtDomains
  deleteEmailDomainResponse:
    title: Delete email domain
    type: object
    properties:
      message:
        description: Message regarding delete operation.
        type: string
      status:
        description: Status of the operation.
        type: boolean
    required:
    - message
    - status
  retrieve-filters-response:
    type: object
    title: filter
    properties:
      id:
        description: ID of the filter.
        type: integer
      name:
        description: Name of the filter.
        type: string
      folderName:
        description: Folder name for the filter.
        type: string
      folderId:
        description: ID of the folder containing the filter.
        type: integer
      listName:
        description: Name of the list to which the filter is associated.
        type: string
      listId:
        description: ID of the list to which the filter is associated.
        type: integer
      createdDate:
        description: Creation date of the filter
        type: string
      modifiedDate:
        description: Last Modified date of the filter
        type: string
      description:
        description: Description of the filter
        type: string
      filterType:
        description: Type of the filter
        type: string
      filterSubType:
        description: Sub-Type of the filter
        type: string
      filterSource:
        description: Filter source
        enum:
        - Profile
        - AppChannel
        - Enactment
        type: string
  filters-collection:
    title: filters
    type: object
    properties:
      items:
        type: array
        items:
          $ref: '#/definitions/retrieve-filters-response'
  triggerCustomEvent:
    title: Trigger Custom Event
    type: object
    properties:
      customEvent:
        description: customEvent.
        type: object
        properties:
          eventNumberDataMapping:
            type: string
            description: custom eventNumberDataMapping.
          eventDateDataMapping:
            type: string
            description: custom eventDateDataMapping.
          eventStringDataMapping:
            type: string
            description: custom eventStringDataMapping.
      recipientData:
        description: Array of Recipients with Optional Data
        type: array
        items:
          type: object
          properties:
            recipient:
              type: object
              description: Information about the Recipient.
              properties:
                customerId:
                  type: string
                  description: Recipient's Customer ID.
                emailAddress:
                  type: string
                  description: Recipient's Email Address.
                emailSHA256Hash:
                  type: string
                  description: Recipient's Email SHA256 Hash.
                emailMD5Hash:
                  type: string
                  description: Recipient's Email MD5 Hash.
                listName:
                  type: object
                  description: Profile List to which the Recipient belongs.
                  properties:
                    folderName:
                      type: string
                      description: Folder Name
                    objectName:
                      type: string
                      description: Profile List Name.
                recipientId:
                  type: number
                  description: Recipient's RIID.
                mobileNumber:
                  type: string
                  description: Recipient's Mobile Number.
                emailFormat:
                  enum:
                  - HTML_FORMAT
                  - TEXT_FORMAT
                  type: string
                  description: Email Format.
              required:
              - customerId
              - emailAddress
              - listName
              - recipientId
              - mobileNumber
              - emailFormat
              - emailMD5Hash
              - emailSHA256Hash
            optionalData:
              type: array
              description: Array of optional data containing name value pairs.
              items:
                type: object
                properties:
                  name:
                    type: string
                  value:
                    type: string
          required:
          - recipient
          - optionalData
    required:
    - customEvent
    - recipientData
  triggerEvent-response:
    title: Trigger Custom Event Response
    type: array
    description: Array of Recipient Results.
    items:
      type: object
      description: Response for individual recipient.
      properties:
        errorMessage:
          type: string
          description: Error Message, if any, that occurred during the merge or trigger operations.
        success:
          type: boolean
          description: Indicates success or failure.
        recipientId:
          type: number
          description: The Responsys ID (RIID) of the recipient.
  events:
    title: Custom Events
    type: object
    properties:
      eventName:
        description: The name of the custom event
        type: string
      description:
        description: The description of the custom event
        type: string
      eventType:
        description: The type of the custom event
        type: string
    required:
    - eventName
    - description
    - eventType
  events-collection:
    title: Custom Events
    type: array
    items:
      $ref: '#/definitions/events'
  triggerReiEvent:
    title: Trigger Rei Event
    type: object
    properties:
      reiEvent:
        description: reiEvent.
        type: object
        properties:
          eventNumberDataMapping:
            type: string
            description: rei eventNumberDataMapping.
          eventDateDataMapping:
            type: string
            description: rei eventDateDataMapping.
          eventStringDataMapping:
            type: string
            description: rei eventStringDataMapping.
      recipientData:
        description: Array of Recipients with Optional Data
        type: array
        items:
          type: object
          properties:
            recipient:
              type: object
              description: Information about the Recipient.
              properties:
                customerId:
                  type: string
                  description: Recipient's Customer ID.
                emailAddress:
                  type: string
                  description: Recipient's Email Address.
                emailSHA256Hash:
                  type: string
                  description: Recipient's Email SHA256 Hash.
                emailMD5Hash:
                  type: string
                  description: Recipient's Email MD5 Hash.
                listName:
                  type: object
                  description: Profile List to which the Recipient belongs.
                  properties:
                    folderName:
                      type: string
                      description: Folder Name
                    objectName:
                      type: string
                      description: Profile List Name.
                mobileAppRecipient:
                  type: object
                  description: Data for push channel recipient
                  properties:
                    deviceId:
                      type: string
                      description: Device Id of the mobile device
                    apiKey:
                      type: string
                      description: API key for the mobile application
                webPushAppRecipient:
                  type: object
                  description: Data for web push channel recipient
                  properties:
                    visitorId:
                      type: string
                      description: Visitor Id of the web push recipient
                    apiKey:
                      type: string
                      description: API key for the web push recipient
                recipientId:
                  type: number
                  description: Recipient's RIID.
                mobileNumber:
                  type: string
                  description: Recipient's Mobile Number.
                emailFormat:
                  enum:
                  - HTML_FORMAT
                  - TEXT_FORMAT
                  type: string
                  description: Email Format.
              required:
              - customerId
              - emailAddress
              - listName
              - recipientId
              - mobileNumber
              - emailFormat
            optionalData:
              type: array
              description: Array of optional data containing name value pairs.
              items:
                type: object
                properties:
                  name:
                    type: string
                  value:
                    type: string
          required:
          - recipient
    required:
    - reiEvent
    - recipientData
  mergeTriggerEmailWithAttachments:
    title: Merge Trigger Email With Attachments
    type: object
    properties:
      mergeTriggerRecordDataWithAttachments:
        description: Record data that represents Field Names and corresponding values for the recipient.
        required:
        - mergeTriggerRecordsWithAttachments
        - fieldNames
        type: object
        properties:
          mergeTriggerRecordsWithAttachments:
            type: array
            description: Array of values corresponding to the fieldNames. Each element in the array represents
              a single recipient.
            items:
              type: object
              properties:
                fieldValues:
                  type: array
                  description: Values corresponding to the fieldNames.
                  items:
                    type: string
                optionalData:
                  type: array
                  description: Optional data containing array of name value pairs.
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                      value:
                        type: string
                attachmentData:
                  type: array
                  description: Attachment data containing array of pairs of file name and content value.
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                      value:
                        type: string
          fieldNames:
            type: array
            description: Array of profile list fields that specifies the recipient record data to be sent
              in the request payload. Must contain the fields specified for matchColumnName1 and, if present,
              matchColumnName2. May contain other profile list fields as needed.
            items:
              type: string
      mergeRule:
        description: Merge rule used to merge recipient records in a Profile List. Only used during the
          merge operation.
        type: object
        properties:
          rejectRecordIfChannelEmpty:
            type: string
            description: String containing comma-separated channel codes that if specified will result
              in record rejection when the channel address field is null. Channel codes are 'E' (Email),
              'M' (Mobile), 'P' (Postal Code). For example 'E,M' would indicate that a record that has
              a null for Email or Mobile Number value should be rejected. This parameter can also be set
              to null or to an empty string, which will cause the validation to not be performed for any
              channel, except if the matchColumnName1 parameter is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_.
              When matchColumnName1 is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_, then the null or empty
              string setting is effectively ignored for that channel.
          htmlValue:
            type: string
            description: Value of incoming preferred email format data. For example, 'H' may represent
              a preference for HTML formatted email.
          textValue:
            type: string
            description: Value of incoming preferred email format data. For example, 'T' may represent
              a preference for Text formatted email.
          matchColumnName1:
            enum:
            - RIID_
            - CUSTOMER_ID_
            - EMAIL_ADDRESS_
            - MOBILE_NUMBER_
            - EMAIL_MD5_HASH_
            - EMAIL_SHA256_HASH_
            type: string
            description: First match column for determining whether an insert or update should occur.
          insertOnNoMatch:
            type: boolean
            description: Indicates what should be done for records where a match is not found (true =
              insert / false = no insert).
          optinValue:
            type: string
            description: Value of incoming opt-in status data that represents an opt-in status. For example,
              'I' may represent an opt-in status.
          defaultPermissionStatus:
            enum:
            - OPTIN
            - OPTOUT
            type: string
            description: This value must be specified as either OPTIN or OPTOUT and would be applied to
              all of the records contained in the API call. If this value is not explicitly specified,
              then it is set to OPTOUT.
          optoutValue:
            type: string
            description: Value of incoming opt-out status data that represents an optout status. For example,
              '0' may represent an opt-out status.
          matchColumnName2:
            enum:
            - RIID_
            - CUSTOMER_ID_
            - EMAIL_ADDRESS_
            - MOBILE_NUMBER_
            - EMAIL_MD5_HASH_
            - EMAIL_SHA256_HASH_
            type: string
            description: Second match column for determining whether an insert or update should occur.
              (optional).
          updateOnMatch:
            enum:
            - REPLACE_ALL
            - NO_UPDATE
            type: string
            description: Controls how the existing record should be updated.
          matchOperator:
            enum:
            - NONE
            - AND
            type: string
            description: Operator to join match column names
    required:
    - mergeTriggerRecordDataWithAttachments
    - mergeRule
  triggerEmailWithAttachmentsResponse:
    title: Trigger Email With Attachments Response
    type: array
    description: Array of Recipient Results.
    items:
      type: object
      description: Response for individual recipient.
      properties:
        errorMessage:
          type: string
          description: Error Message, if any, that occurred during the merge or trigger operations.
        success:
          type: boolean
          description: Indicates success or failure.
        recipientId:
          type: number
          description: The Responsys ID (RIID) of the recipient.
  triggerEmailMessageWithAttachments:
    title: Trigger Email Message With Attachments
    type: object
    properties:
      recipientData:
        description: Array of Recipients with Optional Data
        type: array
        items:
          type: object
          properties:
            recipient:
              type: object
              description: Information about the Recipient.
              properties:
                emailAddress:
                  type: string
                  description: Recipient's Email Address.
                recipientId:
                  type: number
                  description: Recipient's RIID.
                mobileNumber:
                  type: string
                  description: Recipient's Mobile Number.
                customerId:
                  type: string
                  description: Recipient's Customer ID.
                emailMD5Hash:
                  type: string
                  description: Recipient's Email's MD5 Hash.
                emailSHA256Hash:
                  type: string
                  description: Recipient's Email's SHA256 Hash.
              required:
              - customerId
              - emailAddress
              - recipientId
              - mobileNumber
              - emailMD5Hash
              - emailSHA256Hash
            optionalData:
              type: array
              description: Array of optional data containing name value pairs.
              items:
                type: object
                properties:
                  name:
                    type: string
                  value:
                    type: string
                required:
                - name
                - value
            attachmentData:
              type: array
              description: Attachment data containing array of pairs of file name and content value.
              items:
                type: object
                properties:
                  name:
                    type: string
                  value:
                    type: string
                required:
                - name
                - value
          required:
          - recipient
          - optionalData
          - attachmentData
    required:
    - recipientData
  triggerEmailWithAttachments-response:
    title: Trigger Email With Attachments Response
    type: array
    description: Array of Recipient Results.
    items:
      type: object
      description: Response for individual recipient.
      properties:
        errorMessage:
          type: string
          description: Error Message, if any, that occurred during the trigger operation.
        success:
          type: boolean
          description: Indicates success or failure.
        recipientId:
          type: number
          description: The Responsys ID (RIID) of the recipient.
      required:
      - errorMessage
      - success
      - recipientId
  triggerPushMessage:
    title: Trigger Push Message
    type: object
    properties:
      recipientData:
        description: Array of Recipients with Optional Data
        type: array
        items:
          type: object
          properties:
            mobileNumber:
              type: string
              description: Recipient's Mobile Number.
            emailSHA256Hash:
              type: string
              description: Recipient's emailSHA256Hash.
            emailAddress:
              type: string
              description: Recipient's Email Address.
            listType:
              enum:
              - PUSH
              - PROFILE
              description: Email Format.
              type: string
            optionalData:
              type: array
              description: Array of optional data containing name value pairs.
              items:
                type: object
                properties:
                  name:
                    type: string
                  value:
                    type: string
            customerId:
              type: string
              description: Recipient's Customer ID.
            apiKey:
              type: string
              description: Recipient's apiKey.
            emailMD5Hash:
              type: string
              description: Recipient's emailMD5Hash.
            deviceId:
              type: string
              description: Recipient's deviceId.
            recipientId:
              type: number
              description: Recipient's RIID.
    required:
    - recipientData
  triggerPush-response:
    title: Trigger Push Response
    type: array
    description: Array of Recipient Results.
    items:
      type: object
      description: Response for individual recipient.
      properties:
        errorMessage:
          type: string
          description: Error Message, if any, that occurred during the trigger operation.
        success:
          type: boolean
          description: Indicates success or failure.
        recipientId:
          type: number
          description: The Responsys ID (RIID) of the recipient.
  mergeTriggerEmail:
    title: Merge Trigger Email
    type: object
    properties:
      mergeTriggerRecordData:
        description: Record data that represents Field Names and corresponding values for the recipient.
        required:
        - mergeTriggerRecords
        - fieldNames
        type: object
        properties:
          mergeTriggerRecords:
            type: array
            description: Array of values corresponding to the fieldNames. Each element in the array represents
              a single recipient.
            items:
              type: object
              properties:
                fieldValues:
                  type: array
                  description: Values corresponding to the fieldNames.
                  items:
                    type: string
                optionalData:
                  type: array
                  description: Optional data containing array of name value pairs.
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                      value:
                        type: string
          fieldNames:
            type: array
            description: Field Names in the Profile List
            items:
              type: string
      mergeRule:
        description: Merge rule used to merge recipient records in a Profile List. Only used during the
          merge operation.
        type: object
        properties:
          rejectRecordIfChannelEmpty:
            type: string
            description: String containing comma-separated channel codes that if specified will result
              in record rejection when the channel address field is null. Channel codes are 'E' (Email),
              'M' (Mobile), 'P' (Postal Code). For example 'E,M' would indicate that a record that has
              a null for Email or Mobile Number value should be rejected. This parameter can also be set
              to null or to an empty string, which will cause the validation to not be performed for any
              channel, except if the matchColumnName1 parameter is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_.
              When matchColumnName1 is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_, then the null or empty
              string setting is effectively ignored for that channel.
          htmlValue:
            type: string
            description: Value of incoming preferred email format data. For example, 'H' may represent
              a preference for HTML formatted email.
          textValue:
            type: string
            description: Value of incoming preferred email format data. For example, 'T' may represent
              a preference for Text formatted email.
          matchColumnName1:
            enum:
            - RIID_
            - CUSTOMER_ID_
            - EMAIL_ADDRESS_
            - MOBILE_NUMBER_
            - EMAIL_MD5_HASH_
            - EMAIL_SHA256_HASH_
            type: string
            description: First match column for determining whether an insert or update should occur.
          insertOnNoMatch:
            type: boolean
            description: Indicates what should be done for records where a match is not found (true =
              insert / false = no insert).
          optinValue:
            type: string
            description: Value of incoming opt-in status data that represents an opt-in status. For example,
              'I' may represent an opt-in status.
          defaultPermissionStatus:
            enum:
            - OPTIN
            - OPTOUT
            type: string
            description: This value must be specified as either OPTIN or OPTOUT and would be applied to
              all of the records contained in the API call. If this value is not explicitly specified,
              then it is set to OPTOUT.
          optoutValue:
            type: string
            description: Value of incoming opt-out status data that represents an optout status. For example,
              '0' may represent an opt-out status.
          matchColumnName2:
            enum:
            - RIID_
            - CUSTOMER_ID_
            - EMAIL_ADDRESS_
            - MOBILE_NUMBER_
            - EMAIL_MD5_HASH_
            - EMAIL_SHA256_HASH_
            type: string
            description: Second match column for determining whether an insert or update should occur.
              (optional).
          updateOnMatch:
            enum:
            - REPLACE_ALL
            - NO_UPDATE
            type: string
            description: Controls how the existing record should be updated.
          matchOperator:
            enum:
            - NONE
            - AND
            type: string
            description: Operator to join match column names
    required:
    - mergeTriggerRecordData
    - mergeRule
  triggerEmailResponse:
    title: Trigger Email Response
    type: array
    description: Array of Recipient Results.
    items:
      type: object
      description: Response for individual recipient.
      properties:
        errorMessage:
          type: string
          description: Error Message, if any, that occurred during the merge or trigger operations.
        success:
          type: boolean
          description: Indicates success or failure.
        recipientId:
          type: number
          description: The Responsys ID (RIID) of the recipient.
  campaigns:
    title: Campaign
    type: object
    properties:
      autoCloseOption:
        description: Auto close options for this campaign.
        enum:
        - NO_AUTO_CLOSE
        - AUTO_CLOSE_X_DAYS_AFTER_LAUNCH
        - AUTO_CLOSE_X_DAYS_AFTER_LAST_RESPONSE
        - AUTO_CLOSE_ON_DATE
        type: string
      unsubscribeOption:
        description: The unsubscribe option for this campaign.
        enum:
        - NO_OPTOUT_BUTTON
        - OPTOUT_SINGLE_CLICK
        - OPTOUT_FORM
        type: string
      bccEmail:
        description: Bcc Email Address for the campaign.
        type: string
      linkTablePath:
        description: Link table to be included in this campaign.
        type: string
      marketingProgram:
        description: Type of marketing program. The values are defined by the Account Administrator.
        type: string
      segmentPaths:
        description: Segmentations are used to divide a list into segments using attributes of a profile
          extension table or profile list.
        type: array
        items:
          type: string
      refiningDataSourcePath:
        description: Path of additional data sources to be used for this campaign.
        type: string
      proofListPath:
        description: Before sending the campaign to customers, send it to proof list for testing.
        type: string
      attachmentPaths:
        description: Attachments for the campaign.
        type: array
        items:
          type: string
      htmlMessagePath:
        description: HTML message folder and path for the campaign.
        type: string
      fromEmail:
        description: From Email Address for the campaign.
        type: string
      listName:
        description: Profile list name which contains the audience for this campaign.
        type: string
      channelList:
        description: App channel list name which contains the audience for this campaign.
        type: string
      useUTF8:
        description: Use UTF8 encoding for messages.
        type: boolean
      suppressionListPaths:
        description: This is used to exclude recipients from data sources.
        type: array
        items:
          type: string
      replyToEmail:
        description: Reply To Email Address for the campaign.
        type: string
      segmentTrackingColumnName:
        description: Column name for tracking segments.
        type: string
      filterPaths:
        description: Paths of filter to be used for this campaign. This can be used to select a group
          of customers to receive specific messages. Either standard filter or SQL View can be specified.
        type: array
        items:
          type: string
      name:
        description: Name of the campaign.
        type: string
      locale:
        description: The default recipient locale for this account.
        type: string
      supplementarySeedDataSourcePaths:
        description: Supplementary seed data sources can be used for inclusions or exclusions from seed
          list.
        type: array
        items:
          type: string
      textMessagePath:
        description: Text message folder and path for the campaign.
        type: string
      sendTextIfHTMLUnknown:
        description: If HTML ability is unknown, this option allows sending MIME messages to ensure message
          text is displayed correctly.
        type: boolean
      subject:
        description: Campaign Subject.
        type: string
      enableExternalTracking:
        description: Enable to use third-party web analytics service that use tracking parameters appended
          to the URLs.
        type: boolean
      salesForceCampaignId:
        description: Salesforce campaign id.
        type: string
      autoCloseValue:
        description: This represents number of days if autoCloseOption is AUTO_CLOSE_X_DAYS_AFTER_LAUNCH
          or AUTO_CLOSE_X_DAYS_AFTER_LAST_RESPONSE.This represents date if autoCloseOption is AUTO_CLOSE_ON_DATE.
        type: string
      trackConversions:
        description: This applies only when link tracking is enabled for the campaign. This option can
          be used to record conversion when clicking a link and following through a specific web page.
        type: boolean
      campaignVariables:
        description: Map<String, String> of Name and value of campaign variables which are used as default
          values for text replacement.
        type: object
        additionalProperties:
          type: string
      type:
        description: Type of the campaign.
        enum:
        - EMAIL
        - PUSH
        - SMS
        - MMS
        - PUSHIOCAMPAIGN
        type: string
      folderName:
        description: Folder name for the campaign.
        type: string
      marketingStrategy:
        description: Type of marketing strategy. The values are defined by the Account Administrator.
        type: string
      externalTrackingParams:
        description: Map<String, String> of Name and value of external tracking parameters.
        type: object
        additionalProperties:
          type: string
      externalCampaignCode:
        description: External campaign code.
        type: string
      unsubscribeFormName:
        description: Form name to be used for unsubscribing..
        type: string
      seedListPath:
        description: Seed lists recipients receive the campaign when it is launched but are excluded from
          live report.
        type: string
      supplementaryProofDataSourcePaths:
        description: Supplementary proof data sources can be used for inclusions or exclusions from proof
          list.
        type: array
        items:
          type: string
      closedCampaignURL:
        description: The URL to redirect to if a recipient clicks on a link of an already closed campaign.
        type: string
      description:
        description: Description of the campaign.
        type: string
      enableLinkTracking:
        description: Enable to track the links in a campaign.
        type: boolean
      supplementaryCampaignDataSourcePaths:
        description: Supplementary data sources can be used for inclusions or exclusions of the audience.
        type: array
        items:
          type: string
      fromName:
        description: From Name for the campaign.
        type: string
      purpose:
        description: Purpose of the campaign.
        enum:
        - PROMOTIONAL
        - TRANSACTIONAL
        type: string
      trackHTMLOpens:
        description: Enable tracking when each recipient with HTML capability opened the email.
        type: boolean
    required:
    - name
    - folderName
  update-campaign-request:
    type: object
    title: update EMD Campaign request
    properties:
      autoCloseOption:
        description: Auto close options for this campaign.
        enum:
        - NO_AUTO_CLOSE
        - AUTO_CLOSE_X_DAYS_AFTER_LAUNCH
        - AUTO_CLOSE_X_DAYS_AFTER_LAST_RESPONSE
        - AUTO_CLOSE_ON_DATE
        type: string
      unsubscribeOption:
        description: The unsubscribe option for this campaign.
        enum:
        - NO_OPTOUT_BUTTON
        - OPTOUT_SINGLE_CLICK
        - OPTOUT_FORM
        type: string
      bccEmail:
        description: Bcc Email Address for the campaign.
        type: string
      linkTablePath:
        description: Link table to be included in this campaign.
        type: string
      marketingProgram:
        description: Type of marketing program. The values are defined by the Account Administrator.
        type: string
      segmentPaths:
        description: Segmentations are used to divide a list into segments using attributes of a profile
          extension table or profile list.
        type: array
        items:
          type: string
      refiningDataSourcePath:
        description: Path of additional data sources to be used for this campaign.
        type: string
      proofListPath:
        description: Before sending the campaign to customers, send it to proof list for testing.
        type: string
      attachmentPaths:
        description: Attachments for the campaign.
        type: array
        items:
          type: string
      htmlMessagePath:
        description: HTML message folder and path for the campaign.
        type: string
      fromEmail:
        description: From Email Address for the campaign.
        type: string
      listName:
        description: Profile list name which contains the audience for this campaign.
        type: string
      channelList:
        description: App channel list name which contains the audience for this campaign.
        type: string
      useUTF8:
        description: Use UTF8 encoding for messages.
        type: boolean
      suppressionListPaths:
        description: This is used to exclude recipients from data sources.
        type: array
        items:
          type: string
      replyToEmail:
        description: Reply To Email Address for the campaign.
        type: string
      segmentTrackingColumnName:
        description: Column name for tracking segments.
        type: string
      filterPaths:
        description: Paths of filter to be used for this campaign. This can be used to select a group
          of customers to receive specific messages. Either standard filter or SQL View can be specified.
        type: array
        items:
          type: string
      locale:
        description: The default recipient locale for this account.
        type: string
      supplementarySeedDataSourcePaths:
        description: Supplementary seed data sources can be used for inclusions or exclusions from seed
          list.
        type: array
        items:
          type: string
      textMessagePath:
        description: Text message folder and path for the campaign.
        type: string
      sendTextIfHTMLUnknown:
        description: If HTML ability is unknown, this option allows sending MIME messages to ensure message
          text is displayed correctly.
        type: boolean
      subject:
        description: Campaign Subject.
        type: string
      enableExternalTracking:
        description: Enable to use third-party web analytics service that use tracking parameters appended
          to the URLs.
        type: boolean
      salesForceCampaignId:
        description: Salesforce campaign id.
        type: string
      autoCloseValue:
        description: This represents number of days if autoCloseOption is AUTO_CLOSE_X_DAYS_AFTER_LAUNCH
          or AUTO_CLOSE_X_DAYS_AFTER_LAST_RESPONSE.This represents date if autoCloseOption is AUTO_CLOSE_ON_DATE.
        type: string
      trackConversions:
        description: This applies only when link tracking is enabled for the campaign. This option can
          be used to record conversion when clicking a link and following through a specific web page.
        type: boolean
      campaignVariables:
        description: Map<String, String> of Name and value of campaign variables which are used as default
          values for text replacement.
        type: object
        additionalProperties:
          type: string
      marketingStrategy:
        description: Type of marketing strategy. The values are defined by the Account Administrator.
        type: string
      externalTrackingParams:
        description: Map<String, String> of Name and value of external tracking parameters.
        type: object
        additionalProperties:
          type: string
      externalCampaignCode:
        description: External campaign code.
        type: string
      unsubscribeFormName:
        description: Form name to be used for unsubscribing..
        type: string
      seedListPath:
        description: Seed lists recipients receive the campaign when it is launched but are excluded from
          live report.
        type: string
      supplementaryProofDataSourcePaths:
        description: Supplementary proof data sources can be used for inclusions or exclusions from proof
          list.
        type: array
        items:
          type: string
      closedCampaignURL:
        description: The URL to redirect to if a recipient clicks on a link of an already closed campaign.
        type: string
      description:
        description: Description of the campaign.
        type: string
      enableLinkTracking:
        description: Enable to track the links in a campaign.
        type: boolean
      supplementaryCampaignDataSourcePaths:
        description: Supplementary data sources can be used for inclusions or exclusions of the audience.
        type: array
        items:
          type: string
      fromName:
        description: From Name for the campaign.
        type: string
      purpose:
        description: Purpose of the campaign.
        enum:
        - PROMOTIONAL
        - TRANSACTIONAL
        type: string
      trackHTMLOpens:
        description: Enable tracking when each recipient with HTML capability opened the email.
        type: boolean
  create-update-retrieve-campaign-response:
    type: object
    title: Campaign
    properties:
      autoCloseOption:
        description: Auto close options for this campaign.
        enum:
        - NO_AUTO_CLOSE
        - AUTO_CLOSE_X_DAYS_AFTER_LAUNCH
        - AUTO_CLOSE_X_DAYS_AFTER_LAST_RESPONSE
        - AUTO_CLOSE_ON_DATE
        type: string
      unsubscribeOption:
        description: The unsubscribe option for this campaign.
        enum:
        - NO_OPTOUT_BUTTON
        - OPTOUT_SINGLE_CLICK
        - OPTOUT_FORM
        type: string
      campaignStatus:
        description: Status of the campaign.
        enum:
        - NONE
        - DRAFT
        - ACTIVE
        - CLOSED
        type: string
      bccEmail:
        description: Bcc Email Address for the campaign.
        type: string
      linkTablePath:
        description: Link table to be included in this campaign.
        type: string
      marketingProgram:
        description: Type of marketing program. The values are defined by the Account Administrator.
        type: string
      segmentPaths:
        description: Segmentations are used to divide a list into segments using attributes of a profile
          extension table or profile list.
        type: array
        items:
          type: string
      refiningDataSourcePath:
        description: Path of additional data sources to be used for this campaign.
        type: string
      proofListPath:
        description: Before sending the campaign to customers, send it to proof list for testing.
        type: string
      attachmentPaths:
        description: Attachments for the campaign.
        type: array
        items:
          type: string
      htmlMessagePath:
        description: HTML message folder and path for the campaign.
        type: string
      fromEmail:
        description: From Email Address for the campaign.
        type: string
      id:
        description: ID of the campaign.
        type: string
      listName:
        description: Profile list name which contains the audience for this campaign.
        type: string
      useUTF8:
        description: Use UTF8 encoding for messages.
        type: boolean
      suppressionListPaths:
        description: This is used to exclude recipients from data sources.
        type: array
        items:
          type: string
      replyToEmail:
        description: Reply To Email Address for the campaign.
        type: string
      segmentTrackingColumnName:
        description: Column name for tracking segments.
        type: string
      filterPaths:
        description: Paths of filter to be used for this campaign. This can be used to select a group
          of customers to receive specific messages. Either standard filter or SQL View can be specified.
        type: array
        items:
          type: string
      name:
        description: Name of the campaign.
        type: string
      locale:
        description: The default recipient locale for this account.
        type: string
      supplementarySeedDataSourcePaths:
        description: Supplementary seed data sources can be used for inclusions or exclusions from seed
          list.
        type: array
        items:
          type: string
      textMessagePath:
        description: Text message folder and path for the campaign.
        type: string
      sendTextIfHTMLUnknown:
        description: If HTML ability is unknown, this option allows sending MIME messages to ensure message
          text is displayed correctly.
        type: boolean
      subject:
        description: Campaign Subject.
        type: string
      enableExternalTracking:
        description: Enable to use third-party web analytics service that use tracking parameters appended
          to the URLs.
        type: boolean
      salesForceCampaignId:
        description: Salesforce campaign id.
        type: string
      autoCloseValue:
        description: This represents number of days if autoCloseOption is AUTO_CLOSE_X_DAYS_AFTER_LAUNCH
          or AUTO_CLOSE_X_DAYS_AFTER_LAST_RESPONSE.This represents date if autoCloseOption is AUTO_CLOSE_ON_DATE.
        type: string
      trackConversions:
        description: This applies only when link tracking is enabled for the campaign. This option can
          be used to record conversion when clicking a link and following through a specific web page.
        type: boolean
      campaignVariables:
        description: Map<String, String> of Name and value of campaign variables which are used as default
          values for text replacement.
        type: object
        additionalProperties:
          type: string
      type:
        description: 'Type of the campaign. It can be EMAIL or PUSH or SMS or MMS or PUSHIOCAMPAIGN. '
        enum:
        - EMAIL
        - PUSH
        - SMS
        - MMS
        - PUSHIOCAMPAIGN
        type: string
      folderName:
        description: Folder name for the campaign.
        type: string
      marketingStrategy:
        description: Type of marketing strategy. The values are defined by the Account Administrator.
        type: string
      externalTrackingParams:
        description: Map<String, String> of Name and value of external tracking parameters.
        type: object
        additionalProperties:
          type: string
      externalCampaignCode:
        description: External campaign code.
        type: string
      unsubscribeFormName:
        description: Form name to be used for unsubscribing..
        type: string
      seedListPath:
        description: Seed lists recipients receive the campaign when it is launched but are excluded from
          live report.
        type: string
      supplementaryProofDataSourcePaths:
        description: Supplementary proof data sources can be used for inclusions or exclusions from proof
          list.
        type: array
        items:
          type: string
      closedCampaignURL:
        description: The URL to redirect to if a recipient clicks on a link of an already closed campaign.
        type: string
      description:
        description: Description of the campaign.
        type: string
      enableLinkTracking:
        description: Enable to track the links in a campaign.
        type: boolean
      supplementaryCampaignDataSourcePaths:
        description: Supplementary data sources can be used for inclusions or exclusions of the audience.
        type: array
        items:
          type: string
      fromName:
        description: From Name for the campaign.
        type: string
      purpose:
        description: Purpose of the campaign.
        enum:
        - PROMOTIONAL
        - TRANSACTIONAL
        type: string
      trackHTMLOpens:
        description: Enable tracking when each recipient with HTML capability opened the email.
        type: boolean
      appName:
        description: Name of the app associated with the campaign. Only applicable to Message Center campaigns
        type: string
      destinationMessageCenter:
        description: Destination Message Center for the campaign. Only applicable to Message Center campaigns
        type: string
  campaigns-collection:
    title: EMD Campaigns
    type: object
    properties:
      items:
        type: array
        items:
          $ref: '#/definitions/create-update-retrieve-campaign-response'
  searchCampaigns-response:
    type: object
    title: searchCampaigns-response
    properties:
      items:
        type: array
        items:
          $ref: '#/definitions/searchCampaigns-response'
  searchCampaigns-request-body:
    title: searchCampaigns-request
    type: object
    properties:
      searchCriteria:
        description: Search Criteria section.
        type: object
        properties:
          keyword:
            description: keyword contains the key-value pair for passing the keyword to be searched in
              all campaigns
            type: object
            properties:
              key:
                description: The type of search has to be mentioned in the key. Currently the API supports
                  campaignName.
                type: string
              value:
                description: The keyword that needs to be matched in all campaigns and return all the
                  campaigns whose name and description contains this keyword.
                type: string
      filterCriteria:
        description: Filter Criteria section. Maximum of 2 filter criterias can be passed per API call
        type: object
        properties:
          campaignType:
            description: Campaign Types. Allowed campaign types are email, sms, mms, inapp, push and webpush.
              Campaign Types will be allowed on the access to that particular account. Multiple campaigns
              types can be passed.
            type: array
            items:
              type: string
          campaignStatus:
            description: Campaign Status. Allowed campaign status are active, closed, draft and scheduled.
              Multiple campaign types can be passed
            type: array
            items:
              type: string
          campaignPurpose:
            description: Campaign Purpose. Allowed campaign purposed are Transactional and Promotional.
              Multiple campaign purposes can be passed
            type: array
            items:
              type: string
          createdBy:
            description: Created By. A valid single user name should be passed. All the campaigns created
              by this user will be returned
            type: string
          createdOn:
            description: Created On Date should be in MM-dd-yyyy format. Maximum limit  of 90 days. All
              the campaigns created from the given date till today's date range will be returned
            type: string
          modifiedBy:
            description: Modified By. A valid single user name should be passed. All the campaigns modified
              by this user will be returned
            type: string
          modifiedOn:
            description: Modified On Date should be in MM-dd-yyyy format. Maximum limit  of 90 days. All
              the campaigns modified from the given date till today's date range will be returned
            type: string
          folderName:
            description: Folder name. A valid single folder name should be passed. All the campaigns part
              of this folder will be returned
            type: string
          profileList:
            description: Profile List. A valid single profile list name should be passed. All the campaigns
              with this profile list will be returned
            type: string
          filter:
            description: Filter. A valid single filter name should be passed. Filter is always associated
              with Profile List. So if the filter attribute is passed it is mandate to pass the profile
              list name as well
            type: string
          mobileCampaignTemplate:
            description: Mobile Campaign Template. A valid single mobile template name should be passed.
              This attribute has to be passed along with the campaign Type as sms or mms. Allowed values
              are Broadcast, EmailAcquisition, Custom, SmsOptIn, SmsOptOut, TextForResponse, SmsNotification,
              TextForCustomerCare, DirectAPINotification, LMS
            type: string
          marketingStrategy:
            description: Marketing Strategy. A valid single value must be passed. All the campaigns with
              this marketing strategy will be returned
            type: string
          marketingProgram:
            description: Marketing Program. A valid single value must be passed. All the campaigns with
              this marketing program will be returned
            type: string
          shortCodeAndLongCode:
            description: Short-Long code. A valid single value must be passed. This attribute has to be
              passed along with the campaign Type as sms or mms. All the campaigns with this short-long
              code will be returned
            type: string
      sortCriteria:
        description: Sort Criteria section. This section is optional. If no sorting is provided, by default
          ModifiedOn and descending order will be considered
        type: object
        properties:
          field:
            description: Sorting field. Field on which sorting should be done. A single field value should
              be passed. Allowed values are campaignName,campaignType,campaignStatus,channelType,modifiedBy,modifiedOn,createdBy
              and  createdOn
            type: string
          order:
            description: Sorting order. It can be asc for ascending or desc for descending
            type: string
  previewCampaign-response:
    title: previewCampaign-response
    type: object
    properties:
      campaignName:
        description: Name of the campaign
        type: string
      listType:
        description: List type (data source) used for preview. Can be either a Profile List or Proof List.
        type: string
      listName:
        description: Data source name used for preview.
        type: string
      riid:
        description: RIID used for preview.
        type: string
      preview:
        type: array
        items:
          $ref: '#/definitions/preview-response'
  preview-response:
    title: preview-response
    type: object
    properties:
      type:
        description: Preview type (text or html)
        type: string
      data:
        description: Preview data
        type: string
  profileListRecipients:
    title: Profile List Recipients
    type: object
    properties:
      recordData:
        description: Record data that represents Field Names and corresponding values for the recipient.
        required:
        - fieldNames
        - records
        type: object
        properties:
          fieldNames:
            type: array
            description: Field Names in the Profile List
            items:
              type: string
          records:
            type: array
            description: Array of values corresponding to the fieldNames. Each element in the array represents
              a single recipient.
            items:
              type: array
              description: Field Values for the recipient in the Profile List
              items:
                type: string
          mapTemplateName:
            type: string
            description: The Map Template in Responsys that can be used to map Field Names of the Profile
              List to Column Names.
      mergeRule:
        description: Merge rule used to merge recipient records in a Profile List. Only used during the
          merge operation.
        type: object
        properties:
          rejectRecordIfChannelEmpty:
            type: string
            description: String containing comma-separated channel codes that if specified will result
              in record rejection when the channel address field is null. Channel codes are 'E' (Email),
              'M' (Mobile), 'P' (Postal Code). For example 'E,M' would indicate that a record that has
              a null for Email or Mobile Number value should be rejected. This parameter can also be set
              to null or to an empty string, which will cause the validation to not be performed for any
              channel, except if the matchColumnName1 parameter is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_.
              When matchColumnName1 is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_, then the null or empty
              string setting is effectively ignored for that channel.
          htmlValue:
            type: string
            description: Value of incoming preferred email format data. For example, 'H' may represent
              a preference for HTML formatted email.
          textValue:
            type: string
            description: Value of incoming preferred email format data. For example, 'T' may represent
              a preference for Text formatted email.
          matchColumnName1:
            enum:
            - RIID_
            - CUSTOMER_ID_
            - EMAIL_ADDRESS_
            - MOBILE_NUMBER_
            - EMAIL_MD5_HASH_
            - EMAIL_SHA256_HASH_
            type: string
            description: First match column for determining whether an insert or update should occur.
          insertOnNoMatch:
            type: boolean
            description: Indicates what should be done for records where a match is not found (true =
              insert / false = no insert).
          optinValue:
            type: string
            description: Value of incoming opt-in status data that represents an opt-in status. For example,
              'I' may represent an opt-in status.
          defaultPermissionStatus:
            enum:
            - OPTIN
            - OPTOUT
            type: string
            description: This value must be specified as either OPTIN or OPTOUT and would be applied to
              all of the records contained in the API call. If this value is not explicitly specified,
              then it is set to OPTOUT.
          optoutValue:
            type: string
            description: Value of incoming opt-out status data that represents an optout status. For example,
              '0' may represent an opt-out status.
          matchColumnName2:
            enum:
            - RIID_
            - CUSTOMER_ID_
            - EMAIL_ADDRESS_
            - MOBILE_NUMBER_
            - EMAIL_MD5_HASH_
            - EMAIL_SHA256_HASH_
            type: string
            description: Second match column for determining whether an insert or update should occur.
              (optional).
          updateOnMatch:
            enum:
            - REPLACE_ALL
            - NO_UPDATE
            type: string
            description: Controls how the existing record should be updated.
          matchOperator:
            enum:
            - NONE
            - AND
            type: string
            description: Operator to join match column names
    required:
    - recordData
    - mergeRule
  deleteListRecipientsRequest:
    title: Delete List Recipients
    type: object
    properties:
      queryAttribute:
        description: Query Attribute based on which records will be deleted. Can have the values r(RIID),e(email
          address),m(mobile number),c(customer id)
        type: string
      ids:
        type: array
        description: Array of values corresponding to the fieldNames.
        items:
          type: array
          description: Field Values for the recipient in the Profile List
          items:
            type: string
    required:
    - queryAttribute
    - ids
  retrieveListRecipientsRequest:
    title: Retrieve List Recipients
    type: object
    properties:
      queryAttribute:
        description: Query Attribute based on which records will be retrieved. Can have the values r(RIID),e(email
          address),m(mobile number),c(customer id), e_md5(EMAIL_MD5_HASH_), e_sha256(EMAIL_SHA256_HASH_)
        type: string
      fieldList:
        type: array
        description: Array of field names to be retrieved
        items:
          type: array
          description: Field Name in the Profile List
          items:
            type: string
      ids:
        type: array
        description: Array of values corresponding to the fieldNames.
        items:
          type: array
          description: Field Values for the recipient in the Profile List
          items:
            type: string
    required:
    - queryAttribute
    - fieldList
    - ids
  retrieveListRecipientCount:
    title: Retrieve List Recipients Count
    type: object
    properties:
      count:
        description: Count of list recipients that matches the query attribute passed or total count of
          list recipients when no query attributes are passed
        type: integer
      links:
        type: object
        description: link URLs that represents next link table APIs
        properties:
          rel:
            type: string
            description: link table API name
          href:
            type: string
            description: URI of link table API
          method:
            type: string
            description: request method type
    required:
    - count
    - links
  deleteListRecipientsUsingQueryAttributes:
    title: Delete List Recipients Using Query Attributes
    type: object
    properties:
      recordData:
        description: Record data that represents Field Names and corresponding values for the recipient.
        required:
        - fieldNames
        - records
        type: object
        properties:
          fieldNames:
            type: array
            description: Field Names in the Profile List
            items:
              type: string
          records:
            type: array
            description: Array of values corresponding to the fieldNames. Each element in the array represents
              a single recipient.
            items:
              type: array
              description: Field Values for the recipient in the Profile List
              items:
                type: string
          mapTemplateName:
            type: string
            description: The Map Template in Responsys that can be used to map Field Names of the Profile
              List to Column Names.
      totalMatchedRecords:
        description: Total Count of Records that matches the query attribute value passed
        type: integer
      remainingRecordCount:
        description: Remaining Records count after the deletion. Maximum of 10 records are deleted for
          the matched query attribute value passed
        type: integer
      hasMoreRecords:
        description: True if the remainingRecordCount is not 0 or False if the remainingRecordCount is
          0
        type: boolean
      links:
        type: object
        description: link URLs that represents next link table APIs
        properties:
          rel:
            type: string
            description: link table API name
          href:
            type: string
            description: URI of link table API
          method:
            type: string
            description: request method type
    required:
    - recordData
    - links
    - totalMatchedRecords
    - remainingRecordCount
    - hasMoreRecords
  bulkProfileExtensionRecipients:
    title: bulk profile Extension Recipients
    type: object
    properties:
      fieldList:
        type: array
        description: field names list
        items:
          type: string
      queryAttribute:
        type: string
        description: query attribute
      ids:
        type: array
        description: email ids list
        items:
          type: string
  profileExtensionRecipients:
    title: Profile Extension Recipients
    type: object
    properties:
      recordData:
        description: Record data that represents field names and corresponding values for the recipient.
        required:
        - fieldNames
        - records
        type: object
        properties:
          fieldNames:
            type: array
            description: Field names of the Profile List. Must contain contain at least one of the merge
              key fields from the Profile List.
            items:
              type: string
          records:
            type: array
            description: Array of values corresponding to the fieldNames. Each element in the array represents
              a single recipient.
            items:
              type: array
              description: Field values for the recipient in the Profile List
              items:
                type: string
          mapTemplateName:
            type: string
            description: The map template in Responsys that can be used to map field names of the Profile
              List to column names.
      insertOnNoMatch:
        description: Specifies whether a recipient record should be inserted into the Profile Extension
          if it does not already exist. Only used during the merge operation.
        type: boolean
      updateOnMatch:
        description: Specifies whether a recipient record should be updated in the Profile Extension if
          it already exists. Only used during the merge operation.
        enum:
        - REPLACE_ALL
        - NO_UPDATE
      matchColumn:
        description: The column name to be used to match the recipient record to the Profile Extension
          records. Only used during the merge operation.
        enum:
        - RIID
        - CUSTOMER_ID
        - EMAIL_ADDRESS
        - MOBILE_NUMBER
        - EMAIL_MD5_HASH
        - EMAIL_SHA256_HASH
    required:
    - recordData
    - insertOnNoMatch
    - updateOnMatch
    - matchColumn
  triggerEmailMessage:
    title: Trigger Email Message
    type: object
    properties:
      recipientData:
        description: Array of Recipients with Optional Data
        type: array
        items:
          type: object
          properties:
            recipient:
              type: object
              description: Information about the Recipient.
              properties:
                customerId:
                  type: string
                  description: Recipient's Customer ID.
                emailAddress:
                  type: string
                  description: Recipient's Email Address.
                emailMD5Hash:
                  type: string
                  description: Recipient's MD5 Email Hash Value.
                emailSHA256Hash:
                  type: string
                  description: Recipient's SHA256 Email Hash Value.
                listName:
                  type: object
                  description: Profile List to which the Recipient belongs.
                  properties:
                    folderName:
                      type: string
                      description: Folder Name
                    objectName:
                      type: string
                      description: Profile List Name.
                recipientId:
                  type: number
                  description: Recipient's RIID.
                mobileNumber:
                  type: string
                  description: Recipient's Mobile Number.
                emailFormat:
                  enum:
                  - HTML_FORMAT
                  - TEXT_FORMAT
                  type: string
                  description: Email Format.
              required:
              - customerId
              - emailAddress
              - recipientId
              - mobileNumber
              - emailFormat
            optionalData:
              type: array
              description: Array of optional data containing name value pairs.
              items:
                type: object
                properties:
                  name:
                    type: string
                  value:
                    type: string
          required:
          - recipient
          - optionalData
    required:
    - recipientData
  triggerEmail-response:
    title: Trigger Email Response
    type: array
    description: Array of Recipient Results.
    items:
      type: object
      description: Response for individual recipient.
      properties:
        errorMessage:
          type: string
          description: Error Message, if any, that occurred during the trigger operation.
        success:
          type: boolean
          description: Indicates success or failure.
        recipientId:
          type: number
          description: The Responsys ID (RIID) of the recipient.
  sup-table:
    title: Supplemental Data table
    type: object
    properties:
      name:
        description: The name of the Supplemental data table
        type: string
      folderName:
        description: The name of the folder in which the Supplemental data table exists
        type: string
      fields:
        description: The Supplemental data table Fields
        type: array
        items:
          type: object
          properties:
            fieldName:
              type: string
              description: The Supplemental data Field Name
            fieldType:
              type: string
              description: The Supplemental data Field Type
    required:
    - name
    - folderName
    - fields
  supp-tables:
    title: Supplemental Data Tables
    type: object
    properties:
      items:
        type: array
        items:
          $ref: '#/definitions/sup-table'
  supplementalTable:
    title: create supplemental table Request
    type: object
    properties:
      table:
        description: Supplemental table name
        type: object
        properties:
          objectName:
            type: string
            description: Name of the supplemental table
      records:
        description: 'Array of columns corresponding to the supplemental table. '
        type: array
        items:
          type: object
          properties:
            fieldName:
              type: string
              description: The supplemental table Field Name
            fieldType:
              type: string
              description: The supplemental table Field Type
            dataExtractionKey:
              type: boolean
              description: Data Extraction Key column of the supplemental table
      primaryKeys:
        description: Array of primary keys corresponding to the supplemental table.
        type: array
        items:
          type: string
  supplementalTableResponse:
    title: create supplemental table Response
    type: boolean
    description: true/false indicating success or failure.
  update-supp-table:
    title: Update Supplemental Data Table Response
    type: object
    properties:
      message:
        description: 'Message: Supplemental Table has been updated will be displayed'
        type: string
      status:
        description: true or false
        type: boolean
    required:
    - message
    - status
  update-supp-request:
    title: Update Supplemental Data Table Request
    type: object
    properties:
      folderName:
        description: The name of the folder where the supplemental table is located.
        type: string
      tableName:
        description: The name of the supplemental table to update.
        type: string
    required:
    - folderName
    - tableName
  getFolders-response:
    title: Retrieve Folders
    type: object
    properties:
      folders:
        description: Array of Folders in an Account
        type: array
        items:
          type: object
          properties:
            id:
              type: string
              description: ID of the Folder.
            name:
              type: string
              description: Name of the Folder.
            subType:
              type: string
              description: SubType of the Folder.
            objSource:
              type: string
              description: Folder Source.
            accountId:
              type: string
              description: Account ID of the Folder.
            status:
              type: string
              description: Status of the Folder(A or D).
            createdBy:
              type: string
              description: Folder Created by.
            modifiedBy:
              type: string
              description: Last Modified by.
            createdDate:
              type: string
              description: Create Date of the Folder.
            modifiedDate:
              type: string
              description: Last Modified Date.
            objectType:
              type: string
              description: Type of the Object(Folder).
            new:
              type: boolean
              description: Is the Folder a new Folder.
  getFolderContent-response:
    title: Retrieve Folder Content
    type: object
    properties:
      riObjects:
        description: Array of Objects in the given folder
        type: array
        items:
          type: object
          properties:
            id:
              type: string
              description: ID of the Object.
            name:
              type: string
              description: Name of the Object.
            type:
              type: string
              description: Type of the Object.
            subType:
              type: string
              description: SubType of the Object.
            folderId:
              type: string
              description: Id of the Folder containing the object.
  createFolderRequest:
    title: Create Folder Request
    type: object
    properties:
      folderName:
        description: Name of the folder to create.
        type: string
  createFolderResponse:
    title: Create Folder Response
    type: object
    properties:
      folderId:
        type: string
        description: ID of the new folder.
      errorMessage:
        type: string
        description: Error message if folder creation fails.
      success:
        type: boolean
        description: Returns <code>true</code> if folder created successfully, <code>false</code> otherwise
  proofList:
    title: Proof List
    type: object
    properties:
      name:
        description: Proof List Name
        type: string
      description:
        description: Proof List description
        type: string
      listName:
        description: Profile list name for which the Proof List is associated
        type: string
      folderName:
        description: Folder containing the Proof List
        type: string
      createdBy:
        description: User who created the Proof List
        type: string
      createdDate:
        description: Proof List creation date
        type: string
        format: date
      modifiedBy:
        description: User who modified the Proof List
        type: string
      modifiedDate:
        description: Proof List modification date
        type: string
        format: date
    required:
    - name
    - description
    - listName
    - folderName
    - createdBy
    - createdDate
    - modifiedBy
    - modifiedDate
  campaignProofListAttributeResponse:
    title: Campaign Proof List Response
    type: object
    properties:
      attributeName:
        description: The attribute of the campaign. "ProofList" in this scenario
        type: string
        enum:
        - proofList
      attributeData:
        $ref: '#/definitions/proofList'
    required:
    - attributeName
    - attributeData
  campaignProofListAttributeRequest:
    title: Campaign Proof List Request
    type: object
    properties:
      attributeName:
        description: 'The attribute of the campaign. Should be "proofList" '
        type: string
        enum:
        - proofList
      attributeData:
        description: Describes the attribute of the campaign to be updated
        type: object
        properties:
          name:
            description: The name of the Proof List to update
            type: string
    required:
    - attributeName
    - attributeData
  dataSource:
    title: Campaign DataSource
    type: object
    properties:
      path:
        description: Path to dataSource
        type: string
      alias:
        description: DataSource alias
        type: string
      fields:
        description: An array of Fields of the particular dataSource.
        type: array
        items:
          $ref: '#/definitions/field'
      type:
        description: DataSource type.
        type: string
      default:
        description: Default value of the DataSource
        type: string
    required:
    - path
    - alias
    - fields
    - type
    - default
  campaignDataSourcesAttributeResponse:
    title: Campaign Data Sources Response
    type: object
    properties:
      attributeName:
        description: the attribute of the campaign. "dataSources" in this scenario
        type: string
        enum:
        - dataSources
      attributeData:
        description: Campaign attribute data
        type: object
        properties:
          dataSources:
            description: Array of Data Sources associated with the Campaign
            type: array
            items:
              $ref: '#/definitions/dataSource'
    required:
    - attributeName
    - attributeData
  field:
    title: Field
    type: object
    properties:
      name:
        type: string
        description: Name of the field
      alias:
        type: string
        description: Alias for the field name
      lookUpKey:
        type: boolean
        description: whether the field is a lookup key or not
      defaultValue:
        type: string
        description: default value of the field
    required:
    - name
    - alias
    - lookUpKey
    - defaultValue
  listExtensions:
    title: Profile Extension
    type: object
    properties:
      profileExtension:
        description: The Profile Extension Object
        required:
        - objectName
        - folderName
        type: object
        properties:
          objectName:
            type: string
            description: The name of the Profile Extension
          folderName:
            type: string
            description: The name of the folder in which the Profile Extension exists
      fields:
        description: The Profile Extension Fields
        type: array
        items:
          type: object
          properties:
            fieldName:
              type: string
              description: The Profile Extension Field Name
            fieldType:
              type: string
              description: The Profile Extension Field Type
    required:
    - profileExtension
    - fields
  listExtensions-collection:
    title: List Extensions
    type: object
    properties:
      items:
        type: array
        items:
          $ref: '#/definitions/listExtensions'
  clDocs:
    title: Content Library Documents
    type: object
    properties:
      docPath:
        description: The complete path of the document starting with '/contentlibrary'.
        type: string
      content:
        description: Document content.
        type: string
    required:
    - docPath
    - content
  copy-content-request:
    type: object
    title: copy content document Request
    properties:
      documentPath:
        description: Path of source Document
        type: string
  retrieve-program-response:
    type: object
    title: program
    properties:
      id:
        description: ID of the program.
        type: string
      name:
        description: Name of the program.
        type: string
      folderName:
        description: Folder name for the program.
        type: string
      listName:
        description: Name of the list associated with the program
        type: string
      channels:
        description: List of channels for the program
        type: array
        items:
          type: string
      createdOn:
        description: Creation date of the program
        type: string
      createdBy:
        description: User that created the program
        type: string
      modifiedOn:
        description: Last Modified date of the program
        type: string
      modifiedBy:
        description: User that last modified the program
        type: string
      publishDate:
        description: Last Publish date of the program
        type: string
      unpublishDate:
        description: Unpublish date of the program. It is empty for a program in running state
        type: string
      status:
        description: Status of the program
        enum:
        - NOT_RUNNING
        - RUNNING
        - RUNNING_WITH_ERRORS
        type: string
  programByName-response:
    type: object
    title: programByName-response
    properties:
      id:
        description: ID of the program.
        type: string
      name:
        description: Name of the program.
        type: string
      folderName:
        description: Folder name for the program.
        type: string
      channels:
        description: List of channels for the program
        type: array
        items:
          type: string
      list:
        description: List details associated with the program
        type: object
        properties:
          id:
            type: string
            description: listId
          name:
            type: string
            description: listname
        required:
        - id
        - name
      status:
        description: Status of the program
        enum:
        - RUNNING
        - NOT_RUNNING
        - RUNNING_WITH_ERRORS
        type: string
      createdOn:
        description: Creation date of the program
        type: string
      createdBy:
        description: User that created the program
        type: string
      modifiedOn:
        description: Last Modified date of the program
        type: string
      modifiedBy:
        description: User that last modified the program
        type: string
      publishDate:
        description: Last Publish date of the program
        type: string
      unpublishDate:
        description: Unpublish date of the program. It is not displayed for a program in running state
        type: string
      links:
        type: object
        description: link URLs that represents next link table APIs
        properties:
          rel:
            type: string
            description: link table API name
          href:
            type: string
            description: URI of link table API
          method:
            type: string
            description: request method type
    required:
    - id
    - links
    - name
    - folderName
    - channels
    - list
    - status
    - createdOn
    - createdBy
    - modifiedOn
    - modifiedBy
    - publishDate
  programs-collection:
    title: Programs
    type: object
    properties:
      items:
        type: array
        items:
          $ref: '#/definitions/retrieve-program-response'
  update-program-request:
    title: update-program-request
    type: object
    properties:
      action:
        description: Action to be performed on a given program
        enum:
        - publish
        - unpublish
        type: string
      saveDraft:
        description: Indicates whether to save the draft version or published version
        enum:
        - Y
        - N
        type: string
  update-program-response:
    title: update-program-response
    type: object
    properties:
      status:
        description: Returns SUCCESS if the publish or unpublish is successful. Returns FAILURE if action
          is not successful.
        enum:
        - SUCCESS
        - FAILURE
        type: string
      errorMsg:
        description: Error messages when publish or unpublish fails
        type: string
  exit-program-enactments-request:
    title: exit-program-enactments-request
    type: object
    properties:
      action:
        description: Action to perform on program enactments. Must be exit.
        enum:
        - exit
        type: string
      programName:
        description: Name of the program to exit enactments
        type: string
  exit-program-enactments-response:
    title: exit-program-enactments-response
    type: object
    properties:
      status:
        description: SUCCESS if operation is successful otherwise FAILURE
        enum:
        - SUCCESS
        - FAILURE
        type: string
      errorMsg:
        description: Error messages when operation fails
        type: string
  mergeTriggerSMS:
    title: Merge Trigger SMS
    type: object
    properties:
      mergeTriggerRecordData:
        description: Record data that represents Field Names and corresponding values for the recipient.
        required:
        - mergeTriggerRecords
        - fieldNames
        type: object
        properties:
          mergeTriggerRecords:
            type: array
            description: Array of values corresponding to the fieldNames. Each element in the array represents
              a single recipient.
            items:
              type: object
              properties:
                fieldValues:
                  type: array
                  description: Values corresponding to the fieldNames.
                  items:
                    type: string
                optionalData:
                  type: array
                  description: Optional data containing array of name value pairs.
                  items:
                    type: object
                    properties:
                      name:
                        type: string
                      value:
                        type: string
          fieldNames:
            type: array
            description: Field Names in the Profile List. Note <code>MOBILE_NUMBER_</code> must be specified
              in the <a href='https://en.wikipedia.org/wiki/E.164'>E.164</a> format.
            items:
              type: string
      mergeRule:
        description: Merge rule used to merge recipient records in a Profile List. Only used during the
          merge operation.
        type: object
        properties:
          rejectRecordIfChannelEmpty:
            type: string
            description: String containing comma-separated channel codes that if specified will result
              in record rejection when the channel address field is null. Channel codes are 'E' (SMS),
              'M' (Mobile), 'P' (Postal Code). For example 'E,M' would indicate that a record that has
              a null for SMS or Mobile Number value should be rejected. This parameter can also be set
              to null or to an empty string, which will cause the validation to not be performed for any
              channel, except if the matchColumnName1 parameter is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_.
              When matchColumnName1 is set to EMAIL_ADDRESS_ or MOBILE_NUMBER_, then the null or empty
              string setting is effectively ignored for that channel.
          htmlValue:
            type: string
            description: Value of incoming preferred email format data. For example, 'H' may represent
              a preference for HTML formatted email.
          textValue:
            type: string
            description: Value of incoming preferred email format data. For example, 'T' may represent
              a preference for Text formatted email.
          matchColumnName1:
            enum:
            - RIID_
            - CUSTOMER_ID_
            - EMAIL_ADDRESS_
            - MOBILE_NUMBER_
            - EMAIL_MD5_HASH_
            - EMAIL_SHA256_HASH_
            type: string
            description: First match column for determining whether an insert or update should occur.
          insertOnNoMatch:
            type: boolean
            description: Indicates what should be done for records where a match is not found (true =
              insert / false = no insert).
          optinValue:
            type: string
            description: Value of incoming opt-in status data that represents an opt-in status. For example,
              'I' may represent an opt-in status.
          defaultPermissionStatus:
            enum:
            - OPTIN
            - OPTOUT
            type: string
            description: This value must be specified as either OPTIN or OPTOUT and would be applied to
              all of the records contained in the API call. If this value is not explicitly specified,
              then it is set to OPTOUT.
          optoutValue:
            type: string
            description: Value of incoming opt-out status data that represents an optout status. For example,
              '0' may represent an opt-out status.
          matchColumnName2:
            enum:
            - RIID_
            - CUSTOMER_ID_
            - EMAIL_ADDRESS_
            - MOBILE_NUMBER_
            - EMAIL_MD5_HASH_
            - EMAIL_SHA256_HASH_
            type: string
            description: Second match column for determining whether an insert or update should occur.
              (optional).
          updateOnMatch:
            enum:
            - REPLACE_ALL
            - NO_UPDATE
            type: string
            description: Controls how the existing record should be updated.
          matchOperator:
            enum:
            - NONE
            - AND
            type: string
            description: Operator to join match column names
    required:
    - mergeTriggerRecordData
    - mergeRule
  triggerSmsResponse:
    title: Trigger SMS Response
    type: array
    description: Array of Recipient Results.
    items:
      type: object
      description: Response for individual recipient.
      properties:
        errorMessage:
          type: string
          description: Error Message, if any, that occurred during the merge or trigger operations.
        success:
          type: boolean
          description: Indicates success or failure.
        recipientId:
          type: number
          description: The Responsys ID (RIID) of the recipient.
  supplementalTableRecords:
    title: Supplemental Table records
    type: object
    properties:
      recordData:
        description: Record data that represents field names and corresponding values for the member.
        required:
        - fieldNames
        - records
        type: object
        properties:
          fieldNames:
            type: array
            description: Field names in the Supplemental Table
            items:
              type: string
          records:
            type: array
            description: Array of values corresponding to the fieldNames. Each element in the array represents
              a single member.
            items:
              type: array
              description: Field values for the member in the Supplemental Table
              items:
                type: string
          mapTemplateName:
            type: string
            description: The map template in Responsys that can be used to map field names of the Supplemental
              Table to column names.
      insertOnNoMatch:
        description: Specifies whether a member record should be inserted into the Supplemental Table
          if it does not already exist.
        type: boolean
      updateOnMatch:
        description: Specifies whether a member record should be updated in the Supplemental Table if
          it already exists.
        enum:
        - REPLACE_ALL
        - NO_UPDATE
        type: string
      matchColumnNames:
        description: The column names to be used to match the member record to the Supplemental Table
          records. Only used during the merge operation.
        type: array
        items:
          type: string
    required:
    - recordData
    - insertOnNoMatch
    - updateOnMatch
    - matchColumnNames
  supplementalTableMemberswithpk:
    title: Supplemental Table members with PK
    type: object
    properties:
      recordData:
        description: Record data that represents field names and corresponding values for the member.
        required:
        - fieldNames
        - records
        type: object
        properties:
          fieldNames:
            type: array
            description: Field names in the Supplemental Table
            items:
              type: string
          records:
            type: array
            description: Array of values corresponding to the fieldNames. Each element in the array represents
              a single member.
            items:
              type: array
              description: Field values for the member in the Supplemental Table
              items:
                type: string
          mapTemplateName:
            type: string
            description: The map template in Responsys that can be used to map field names of the Supplemental
              Table to column names.
      insertOnNoMatch:
        description: Specifies whether a member record should be inserted into the Supplemental Table
          if it does not already exist.
        type: boolean
      updateOnMatch:
        description: Specifies whether a member record should be updated in the Supplemental Table if
          it already exists.
        enum:
        - REPLACE_ALL
        - NO_UPDATE
        type: string
      required: {}
  retrieveSuppFieldsResponse:
    title: Supplemental Data Table fields
    type: object
    properties:
      fields:
        description: The Supplemental Data Table fields
        type: array
        items:
          type: object
          properties:
            fieldName:
              type: string
              description: The supplemental data field name
            fieldType:
              type: string
              description: The supplemental data field type
      suppData:
        description: Metadata about the Supplemental Table
        type: object
        properties:
          objectName:
            description: The name of the Supplemental Data Table
            type: string
          folderName:
            description: The name of the folder in which the Supplemental Data Table exists
            type: string
  campaignSchedule:
    title: Email or Push Campaign Schedule
    type: object
    properties:
      launchOptions:
        description: Launch Options for the schedule.
        type: object
        properties:
          progressChunk:
            enum:
            - CHUNK_10K
            - CHUNK_50K
            - CHUNK_100K
            - CHUNK_500K
            - CHUNK_1M
            type: string
            description: Progress Chunk.
          recipientLimit:
            type: integer
            description: Recipient Limit.
          proofLaunchType:
            enum:
            - LAUNCH_TO_ADDRESS
            - LAUNCH_TO_PROOFLIST
            - LAUNCH_TO_ADDRESS_USING_PROOFLIST
            type: string
            description: Proof Launch type.
          progressEmailAddresses:
            type: array
            description: Email addresses to inform of progress.
            items:
              type: string
          samplingNthOffset:
            type: integer
            description: Sampling offset.
          samplingNthInterval:
            type: integer
            description: Sampling Interval.
          proofLaunch:
            type: boolean
            description: Should a proof launch be performed.
          samplingNthSelection:
            type: integer
            description: Sampling Selection.
          proofLaunchEmail:
            type: string
            description: Email address for the proof launch.
      scheduleType:
        description: Schedule Type.
        enum:
        - NOW
        - ONCE
        type: string
      scheduledTime:
        description: Date in the format yyyy-mm-dd HH:mm
        type: string
      recurringEndTime:
        description: Date in the format yyyy-mm-dd HH:mm
        type: string
    required:
    - scheduleType
    - scheduledTime
  update-campaignSchedule-request:
    type: object
    title: Update Email or Push Campaign Schedule Request
    properties:
      scheduleType:
        description: Schedule Type.
        enum:
        - NOW
        - ONCE
        type: string
      scheduledTime:
        description: Date in the format yyyy-mm-dd HH:mm
        type: string
  update-delete-campaignSchedule-response:
    type: object
    title: Update Email or Push Campaign Schedule Response
    properties:
      id:
        description: ID of the schedule.
        type: string
      scheduleType:
        description: Schedule Type.
        enum:
        - NOW
        - ONCE
        type: string
      scheduledTime:
        description: Date in the format yyyy-mm-dd HH:mm
        type: string
      launchOptions:
        description: Launch Options for the schedule.
        type: object
        properties:
          proofLaunch:
            type: boolean
            description: Should a proof launch be performed.
  create-retrieve-campaignSchedule-response:
    type: object
    title: Email or Push Campaign Schedule
    properties:
      id:
        description: ID of the schedule.
        type: string
      launchOptions:
        description: Launch Options for the schedule.
        type: object
        properties:
          progressChunk:
            enum:
            - CHUNK_10K
            - CHUNK_50K
            - CHUNK_100K
            - CHUNK_500K
            - CHUNK_1M
            type: string
            description: Progress Chunk.
          recipientLimit:
            type: integer
            description: Recipient Limit.
          proofLaunchType:
            enum:
            - LAUNCH_TO_ADDRESS
            - LAUNCH_TO_PROOFLIST
            - LAUNCH_TO_ADDRESS_USING_PROOFLIST
            type: string
            description: Proof Launch type.
          progressEmailAddresses:
            type: array
            description: Email addresses to inform of progress.
            items:
              type: string
          samplingNthOffset:
            type: integer
            description: Sampling offset.
          samplingNthInterval:
            type: integer
            description: Sampling Interval.
          proofLaunch:
            type: boolean
            description: Should a proof launch be performed.
          samplingNthSelection:
            type: integer
            description: Sampling Selection.
          proofLaunchEmail:
            type: string
            description: Email address for the proof launch.
      scheduleType:
        description: Schedule Type.
        enum:
        - NOW
        - ONCE
        type: string
      scheduledTime:
        description: Date in the format yyyy-mm-dd HH:mm
        type: string
      recurringEndTime:
        description: Date in the format yyyy-mm-dd HH:mm
        type: string
  retrieve-campaignSchedule-response:
    type: object
    title: Email or Push Campaign Schedule
    properties:
      id:
        description: ID of the schedule.
        type: string
      launchOptions:
        description: Launch Options for the schedule.
        type: object
        properties:
          progressChunk:
            enum:
            - CHUNK_10K
            - CHUNK_50K
            - CHUNK_100K
            - CHUNK_500K
            - CHUNK_1M
            type: string
            description: Progress Chunk.
          recipientLimit:
            type: integer
            description: Recipient Limit.
          proofLaunchType:
            enum:
            - LAUNCH_TO_ADDRESS
            - LAUNCH_TO_PROOFLIST
            - LAUNCH_TO_ADDRESS_USING_PROOFLIST
            type: string
            description: Proof Launch type.
          progressEmailAddresses:
            type: array
            description: Email addresses to inform of progress.
            items:
              type: string
          samplingNthOffset:
            type: integer
            description: Sampling offset.
          samplingNthInterval:
            type: integer
            description: Sampling Interval.
          proofLaunch:
            type: boolean
            description: Should a proof launch be performed.
          samplingNthSelection:
            type: integer
            description: Sampling Selection.
          proofLaunchEmail:
            type: string
            description: Email address for the proof launch.
      scheduleType:
        description: Schedule Type.
        enum:
        - NOW
        - ONCE
        - RECURRING
        type: string
      scheduledTime:
        description: Date in the format yyyy-mm-dd HH:mm
        type: string
      recurringEndTime:
        description: Date in the format yyyy-mm-dd HH:mm
        type: string
  campaignSchedule-collection:
    title: Email or Push Campaign Schedules
    type: object
    properties:
      items:
        type: array
        items:
          $ref: '#/definitions/retrieve-campaignSchedule-response'
  attribute:
    type: object
    title: attribute
    properties:
      id:
        description: ID of the attribute
        type: string
      name:
        description: Name of the attribute
        type: string
      lineage:
        description: Description of the attribute's heirarchy
        type: string
      children:
        description: Children of the Attribute
        type: array
        items:
          $ref: '#/definitions/attribute'
  assigned-attribute:
    type: object
    title: assigned attribute
    properties:
      id:
        description: ID of the attribute
        type: string
      name:
        description: Name of the attribute
        type: string
      lineage:
        description: Description of the attribute's heirarchy
        type: string
  organizations:
    type: object
    title: attribute
    properties:
      attributeValues:
        description: Value of the Attribute
        type: array
        items:
          $ref: '#/definitions/attribute'
  attributes:
    title: Attributes
    type: object
    properties:
      organizations:
        type: array
        items:
          $ref: '#/definitions/organizations'
  get-organizations-response:
    title: Get Organizations
    type: object
    properties:
      attributes:
        type: object
        properties:
          organizations:
            type: object
            properties:
              attributeValues:
                description: Value of the Attribute
                type: array
                items:
                  $ref: '#/definitions/attribute'
  get-assigned-attributes-response:
    title: Get Assigned Organizations
    type: object
    properties:
      attributes:
        type: object
        properties:
          organizations:
            type: object
            properties:
              attributeValues:
                description: Value of the Assigned Attributes
                type: array
                items:
                  $ref: '#/definitions/assigned-attribute'
  edit-access-attributes-request:
    title: Edit Access Attributes Request
    type: object
    properties:
      attributes:
        type: object
        properties:
          organizations:
            type: object
            properties:
              attributeValues:
                description: List of Attributes to be assigned
                type: array
                items:
                  type: object
                  description: Attribute name
                  properties:
                    name:
                      type: string
                      description: Name of the Attribute to be assigned
  lists:
    title: Profile Lists
    type: object
    properties:
      name:
        description: The name of the Profile List
        type: string
      folderName:
        description: The name of the folder in which the Profile List exists
        type: string
      fields:
        description: The Profile List Fields
        type: array
        items:
          type: object
          properties:
            fieldName:
              type: string
              description: The Profile List Field Name
            fieldType:
              type: string
              description: The Profile List Field Type
    required:
    - name
    - folderName
    - fields
  lists-collection:
    title: Profile Lists
    type: object
    properties:
      items:
        type: array
        items:
          $ref: '#/definitions/lists'
  createProfileListRequest:
    title: Create Profile List Request model
    type: object
    properties:
      listName:
        description: The name of the Profile List
        type: string
      listFolderName:
        description: The name of the folder in which the Profile List is to be created
        type: string
      description:
        description: Description about the Profile list
        type: string
      brandName:
        description: The name of the brand with which the profile list is associated. Required if account
          is brand-enabled.
        type: string
      fields:
        description: The Profile List Fields
        type: array
        items:
          type: object
          properties:
            fieldName:
              type: string
              description: The Profile List Field Name
            fieldType:
              type: string
              description: The Profile List Field Type
          required:
          - fieldName
          - fieldType
    required:
    - listName
    - listFolderName
  createProfileListResponse:
    title: Create Profile List Response model
    type: object
    properties:
      message:
        type: string
        enum:
        - List has been created.
        description: The List has been created
      name:
        type: string
        description: The Profile list Name.
    required:
    - message
    - name
  profileListFieldsResponse:
    title: Profile List Fields Response Model
    type: object
    properties:
      name:
        description: The name of the Profile List
        type: string
      folderName:
        description: The name of the folder in which the Profile List exists
        type: string
      fields:
        description: The Profile List Fields
        type: array
        items:
          type: object
          properties:
            fieldName:
              type: string
              description: The Profile List Field Name
            fieldType:
              type: string
              description: The Profile List Field Type
    required:
    - name
    - folderName
    - fields
  mergeOrgListRecipients:
    title: Merge Org List Recipients
    type: object
    properties:
      recordData:
        description: Record data that represents field names and corresponding values for the recipient.
        required:
        - fieldNames
        - records
        type: object
        properties:
          fieldNames:
            type: array
            description: Field names in the Profile List
            items:
              type: string
          records:
            type: array
            description: Array of values corresponding to the fieldNames. Each element in the array represents
              a single recipient.
            items:
              type: array
              description: Field Values for the recipient in the Profile List
              items:
                type: string
      matchColumnName1:
        enum:
        - RIID_
        - CUSTOMER_ID_
        - EMAIL_ADDRESS_
        - MOBILE_NUMBER_
        - EMAIL_MD5_HASH_
        - EMAIL_SHA256_HASH_
        type: string
        description: First match column for determining whether an insert or update should occur.
      insertOnNoMatch:
        type: boolean
        description: Indicates what should be done for records where a match is not found (true = insert
          / false = no insert).
      updateOnMatch:
        enum:
        - REPLACE_ALL
        - NO_UPDATE
        type: string
        description: Controls how the existing record should be updated.
    required:
    - recordData
    - matchColumnName1
  proofListArray:
    title: Proof List Array
    type: object
    properties:
      proofLists:
        type: array
        items:
          $ref: '#/definitions/proofList'
    required:
    - proofLists
  segmentGroup:
    title: Segment Group
    type: object
    properties:
      name:
        description: Segment Group Name
        type: string
      description:
        description: Segment Group description
        type: string
      profileExtensionName:
        description: Profile Extension name associated with the segment group. If no Profile Extension
          is associated, then it is set to null.
        type: string
      listName:
        description: Profile list name with which the Segment Group is associated
        type: string
      folderName:
        description: Folder containing the Segment Group
        type: string
      createdBy:
        description: User who created the Segment Group
        type: string
      createdDate:
        description: Segment Group creation date
        type: string
        format: date
      modifiedBy:
        description: User who modified the Segment Group
        type: string
      modifiedDate:
        description: Segment Group modification date
        type: string
        format: date
    required:
    - name
    - description
    - profileExtensionName
    - listName
    - folderName
    - createdBy
    - createdDate
    - modifiedBy
    - modifiedDate
  segmentGroupArray:
    title: Segment Group Array
    type: object
    properties:
      segmentGroups:
        type: array
        items:
          $ref: '#/definitions/segmentGroup'
    required:
    - segmentGroups
  clFolders:
    title: Content Library Folders
    type: object
    properties:
      folderPath:
        description: The complete path of the folder starting with /contentlibrary.
        type: string
    required:
    - folderPath
  listClFoldersResponse:
    title: List Content Library Folders Response
    type: object
    properties:
      folders:
        description: Folders within the Content Library Folder
        type: array
        items:
          type: object
          properties:
            folderPath:
              type: string
              description: Full path of the Content Library folder
      documents:
        description: Content Library Documents within the Content Library Folder
        type: array
        items:
          type: object
          properties:
            documentPath:
              type: string
              description: Full path of the Content Library Document
            content:
              type: string
              description: Document content
      items:
        description: Media files within the Content Library Folder
        type: array
        items:
          type: object
          properties:
            itemPath:
              type: string
              description: Full path of the Content Library media file
            itemData:
              type: string
              format: byte
              description: Base64 encoded binary string of the media file content.
  clDocImages:
    title: Content Library Document Images
    type: object
    properties:
      documentPath:
        description: The complete path of the document starting with '/contentlibrary'.
        type: string
      imageData:
        description: Images in the content library document.
        type: array
        items:
          type: object
          properties:
            itemPath:
              type: string
              description: Name of the image in the content library document.
            itemData:
              type: string
              format: byte
              description: Base64 encoded binary string of the image content.
    required:
    - documentPath
    - imageData
  clItems:
    title: Content Library Media Files
    type: object
    properties:
      itemPath:
        description: The complete path of the media file starting with /contentlibrary.
        type: string
      itemData:
        description: Base64 encoded binary string of the media file content.
        type: string
    required:
    - itemPath
    - itemData
  copy-contentItem-request:
    type: object
    title: copy content document Request
    properties:
      itemPath:
        description: Path of source item
        type: string
tags:
- name: Account
  description: API endpoints to enable managing your Responsys account.
- name: Attachments
  description: Send Responsys Email Campaigns with Attachments
- name: Campaign Attributes
  description: Campaign Attributes API endpoints.
- name: Campaigns
  description: Responsys Campaign API Endpoints
- name: Content Library Document Images
  description: Content Library Document Images
- name: Content Library Documents
  description: Documents in the Responsys Interact Suite Content Library.
- name: Content Library Folders
  description: Content Library Folders in the Responsys Interact Suite Content Library.
- name: Content Library Media Items
  description: Media Files in the Responsys Interact Suite Content Library.
- name: Email or Push Campaign Schedule
  description: Schedule an Email or a Push Campaign
- name: Events
  description: Raise Events for Cross-channel Marketing Programs.
- name: Filters
  description: Filters in the Responsys Interact Suite
- name: Folders
  description: Responsys Account Folder API Endpoints
- name: List Extensions
  description: Profile Extensions for a Profile List in the Responsys Interact Suite
- name: Merge Trigger Email
  description: Merge Members to a Profile List and Send Responsys Email Campaigns to them.
- name: Merge Trigger SMS
  description: Merge Members to a Profile List and Send Responsys SMS Campaigns to them
- name: Organizations
  description: Responsys Organizations
- name: Profile Extension Recipients
  description: One or more Recipients within a Profile Extension Table in the Responsys Interact Suite.
- name: Profile List Recipients
  description: One or more Recipients within a Profile List in the Responsys Interact Suite.
- name: Profile Lists
  description: Profile Lists in the Responsys Interact Suite
- name: Programs
  description: Responsys Program API Endpoints
- name: Supplemental Table Members
  description: Members of a Supplemental Data Table in the Responsys Interact Suite.
- name: Supplemental Tables
  description: Supplemental table objects.
- name: Trigger Email Message
  description: Send Responsys Email Campaigns to existing members of a Profile List.
- name: Trigger Push Message
  description: Send Responsys Push Campaigns to existing members of a Profile List
- name: Trigger SMS Message
  description: Trigger SMS messages to existing members of a profile list.