Oracle Responsys REST API

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:
    

# --- truncated at 32 KB (201 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/responsys/refs/heads/main/openapi/responsys-openapi.yml