Marketo Text.json API

The Text.json API from Marketo — 1 operation(s) for text.json.

OpenAPI Specification

marketo-text-json-api-openapi.yml Raw ↑
openapi: 3.0.1
info:
  title: Marketo Engage Rest Approve Text.json 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: Text.json
paths:
  /rest/asset/v1/form/{id}/richText.json:
    post:
      tags:
      - Text.json
      summary: Marketo Add Rich Text Field
      description: 'Adds a rich-text type field to the form. Required Permissions: Read-Write Assets'
      operationId: addRichTextFieldUsingPOST
      parameters:
      - name: id
        in: path
        description: id
        required: true
        schema:
          type: integer
          format: int32
      requestBody:
        description: addRichTextRequest
        content:
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/AddRichTextRequest'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ResponseOfLpFormFieldResponse'
      x-codegen-request-body-name: addRichTextRequest
components:
  schemas:
    AddRichTextRequest:
      required:
      - text
      type: object
      properties:
        text:
          type: string
          description: Multipart file. HTML Content for the rich text field.
    LpFormFieldResponse:
      type: object
      properties:
        blankFields:
          type: integer
          format: int32
        columnNumber:
          type: integer
          format: int32
        dataType:
          type: string
        defaultValue:
          type: string
        fieldMetaData:
          type: object
          properties: {}
        fieldWidth:
          type: integer
          format: int32
        fields:
          type: array
          items:
            type: string
        formPrefill:
          type: boolean
        isSensitive:
          type: boolean
        hintText:
          type: string
        id:
          type: string
        instructions:
          type: string
        label:
          type: string
        labelWidth:
          type: integer
          format: int32
        maxLength:
          type: integer
          format: int32
        required:
          type: boolean
        rowNumber:
          type: integer
          format: int32
        text:
          type: string
        validationMessage:
          type: object
          properties: {}
        visibilityRules:
          $ref: '#/components/schemas/FormFieldVisibilityRuleResponse'
    FormVisibilityRuleDTO:
      type: object
      properties:
        altLabel:
          type: string
        operator:
          type: string
        picklistFilterValues:
          type: array
          items:
            $ref: '#/components/schemas/PickListDTO'
        subjectField:
          type: string
        values:
          type: array
          items:
            type: string
    FormFieldVisibilityRuleResponse:
      type: object
      properties:
        ruleType:
          type: string
        rules:
          type: array
          items:
            $ref: '#/components/schemas/FormVisibilityRuleDTO'
    ResponseOfLpFormFieldResponse:
      type: object
      properties:
        errors:
          type: array
          items:
            $ref: '#/components/schemas/Error'
        requestId:
          type: string
        result:
          type: array
          items:
            $ref: '#/components/schemas/LpFormFieldResponse'
        success:
          type: boolean
        warnings:
          type: array
          items:
            type: string
    PickListDTO:
      type: object
      properties:
        isDefault:
          type: boolean
        label:
          type: string
        selected:
          type: boolean
        value:
          type: string
    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
x-original-swagger-version: '2.0'