# List Merge Properties

## OpenAPI Specification

```yaml
openapi: 3.0.1
info:
  title: ''
  description: ''
  version: 1.0.0
paths:
  /v1/messages/merge_properties:
    get:
      summary: List Merge Properties
      deprecated: false
      description: >-
        Lists merge properties available for Message characterized by given
        input params.


        ## Member properties


        Availability of member properties depends on the service - it can be
        consulted [here](api-3927095) (`member` attribute).


        However, there are services where it is conditional (`"member": null`) -
        it depends on the use case. 

        Based on this, the `member=true` query param should be provided when it
        is expected that the messages will be sent to MPC members.
      tags:
        - API Reference/Messaging API/Misc
      parameters:
        - name: service
          in: query
          description: Service name for the Message
          required: true
          example: campaigns
          schema:
            type: string
        - name: member
          in: query
          description: 'See: [here](api-3802016)'
          required: false
          example: 'true'
          schema:
            type: boolean
            nullable: true
        - name: channel
          in: query
          description: >-
            When given, only merge properties available for this channel will be
            returned
          required: false
          example: email
          schema:
            type: string
            enum:
              - sms
              - email
              - push
            x-apidog-enum:
              - value: sms
                name: ''
                description: ''
              - value: email
                name: ''
                description: ''
              - value: push
                name: ''
                description: ''
            nullable: true
        - name: Content-Type
          in: header
          description: '[Details](doc-341635)'
          required: true
          example: application/json
          schema:
            type: string
            default: application/json
            const: application/json
        - name: X-User-Agent
          in: header
          description: Arbitrary identifier of your client. [Details](doc-341635)
          required: true
          example: '{{X_USER_AGENT}}'
          schema:
            type: string
            default: '{{X_USER_AGENT}}'
        - name: X-Product-Name
          in: header
          description: API Product for API context. [Details](doc-341635)
          required: true
          example: '{{PRODUCT_NAME}}'
          schema:
            type: string
            default: '{{PRODUCT_NAME}}'
        - name: X-Loyalty-Club-Slug
          in: header
          description: LoyaltyClub for API context. [Details](doc-342138)
          required: false
          example: '{{LOYALTY_CLUB_SLUG}}'
          schema:
            type: string
            default: '{{LOYALTY_CLUB_SLUG}}'
        - name: X-Customer
          in: header
          description: Customer for API context.  [Details](doc-342139)
          required: false
          example: '{{CUSTOMER_ID}}'
          schema:
            type: string
            default: '{{CUSTOMER_ID}}'
        - name: Authorization
          in: header
          description: '[Member](doc-342129) or [User](doc-342130) Authorization.'
          required: false
          example: Bearer {{_OAUTH_TOKEN}}
          schema:
            type: string
            default: Bearer {{_OAUTH_TOKEN}}
        - name: X-Client-Authorization
          in: header
          description: '[Token](doc-342128) Authorization.'
          example: '{{API_TOKEN}}'
          schema:
            type: string
            default: '{{API_TOKEN}}'
        - name: X-Locale
          in: header
          description: Desired content language. [Details](doc-341959)
          required: false
          example: '{{LOCALE}}'
          schema:
            type: string
            default: '{{LOCALE}}'
      responses:
        '200':
          description: ''
          content:
            application/json:
              schema:
                type: object
                properties:
                  merge_properties:
                    type: array
                    items:
                      type: object
                      properties:
                        value:
                          type: string
                          examples:
                            - code
                            - loyalty_club_name
                          description: >-
                            Merge property value when used in Message template
                            as {{ value }}
                        required:
                          type: boolean
                          description: Is the proparty required for the Message template
                        title:
                          type: string
                          nullable: true
                        channel:
                          type: string
                          enum:
                            - sms
                            - email
                            - push
                          x-apidog-enum:
                            - value: sms
                              name: ''
                              description: ''
                            - value: email
                              name: ''
                              description: ''
                            - value: push
                              name: ''
                              description: ''
                          description: >-
                            When not null, the property is available only on
                            this specific channel
                          nullable: true
                        type:
                          type: string
                          description: Context from which the properties are available
                          enum:
                            - service
                            - global
                            - member_attribute
                            - member_property
                            - member_link
                          x-apidog-enum:
                            - value: service
                              name: ''
                              description: Property is specific for this service
                            - value: global
                              name: ''
                              description: Property is globally available
                            - value: member_attribute
                              name: ''
                              description: >-
                                Property (standard) is specific for member
                                recipient
                            - value: member_property
                              name: ''
                              description: >-
                                Property (custom) is specific for member
                                recipient 
                            - value: member_link
                              name: ''
                              description: Property (link) is specific for member recipient
                      x-apidog-orders:
                        - type
                        - value
                        - title
                        - channel
                        - required
                      required:
                        - value
                        - required
                        - title
                        - type
                x-apidog-orders:
                  - merge_properties
          headers: {}
          x-apidog-name: Success
      security: []
      x-apidog-folder: API Reference/Messaging API/Misc
      x-apidog-status: released
      x-run-in-apidog: https://app.eu.apidog.com/web/project/346351/apis/api-3802016-run
components:
  schemas: {}
  securitySchemes: {}
servers:
  - url: https://api.mpc.dev.placewise.com
    description: Staging
security: []

```