openapi: 3.0.1
info:
  title: Marketo Engage Rest Approve Variable API
  description: Marketo exposes a REST API which allows for remote execution of many of the systems capabilities. From creating programs to bulk lead import, there are many options which allow fine-grained control of a Marketo instance.
  termsOfService: https://www.adobe.com/legal.html
  contact:
    name: Adobe Developer Relations
    url: https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/home
    email: developerfeedback@marketo.com
  license:
    name: API License Agreement
    url: https://experienceleague.adobe.com/en/docs/marketo-developer/marketo/api-license
  version: '1.0'
servers:
- url: https://localhost:8080/
tags:
- name: Variable
paths:
  /rest/asset/v1/email/{id}/variable/{name}.json:
    post:
      tags:
      - Variable
      summary: Marketo Update Email Variable
      description: 'Updates the value of a given variable in an email. Required Permissions: Read-Write Assets'
      operationId: updateVariableUsingPOST
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: name
        in: path
        description: name
        required: true
        schema:
          type: string
      requestBody:
        description: updateVariableRequest
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UpdateVariableRequest'
        required: false
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfEmailVariableResponse'
      x-codegen-request-body-name: updateVariableRequest
  /rest/asset/v1/landingPage/{id}/variable/{variableId}.json:
    post:
      tags:
      - Variable
      summary: Marketo Update Landing Page Variable
      description: 'Updates the value of the given variable. Required Permissions: Read-Write Assets'
      operationId: updateLandingPageVariableUsingPOST
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      - name: variableId
        in: path
        description: variableId
        required: true
        schema:
          type: string
      - name: value
        in: query
        description: New value of the variable
        required: true
        schema:
          type: integer
          format: int32
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfLandingPageVariableResponse'
components:
  schemas:
    ResponseOfEmailVariableResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        requestId:
          type: string
        result:
          type: array
          items:
            $ref: '#/components/schemas/EmailVariableResponse'
        success:
          type: boolean
        warnings:
          type: array
          items:
            type: string
    ResponseOfLandingPageVariableResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        requestId:
          type: string
        result:
          type: array
          items:
            $ref: '#/components/schemas/LandingPageVariableResponse'
        success:
          type: boolean
        warnings:
          type: array
          items:
            type: string
    EmailVariableResponse:
      required:
      - moduleScope
      - name
      - value
      type: object
      properties:
        name:
          type: string
          description: Name of the email variable
        value:
          type: string
          description: Value of the email variable
        moduleScope:
          type: boolean
          description: Returns true for local variables else returns false
        moduleId:
          type: string
          description: Returns the moduleId associated with the variable, only in case of local variable
    UpdateVariableRequest:
      type: object
      properties:
        value:
          type: string
          description: Value to update variable with
        moduleId:
          type: string
          description: Module that variable is associated with. Required for updating module variables. Not needed for global variables.
    Error:
      required:
      - code
      - message
      type: object
      properties:
        code:
          type: string
          description: Error code of the error. See full list of error codes <a href="https://developers.marketo.com/rest-api/error-codes/">here</a>
        message:
          type: string
          description: Message describing the cause of the error
    LandingPageVariableResponse:
      required:
      - id
      type: object
      properties:
        id:
          type: string
          description: Integer id of the variable
        type:
          type: string
          description: Type of the variable
        value:
          type: object
          properties: {}
          description: Value of the variable
x-original-swagger-version: '2.0'