Merge Docs

POST

/passthrough

https://api.merge.dev/api/filestorage/v1/passthrough

Pull data from an endpoint not currently supported by Merge.

Header Parameters

AuthorizationString

Required

Token-based authentication with required prefix "Bearer"

X-Account-TokenString

Required

Token identifying the end user.

Body Parameters

methodEnum

Required

Must pass in one of the following choices: GET, OPTIONS, HEAD, POST, PUT, PATCH, DELETE.

pathString

Required

base_url_overrideString

Optional

dataString

Optional

multipart_form_dataArray

Optional

Pass an array of MultipartFormField objects in here instead of using the data param if request_format is set to MULTIPART.

The object

The MultipartFormField object is used to represent fields in an HTTP request using multipart/form-data.

JSON


{
  "name": "resume",
  "data": "SW50ZWdyYXRlIGZhc3QKSW50ZWdyYXRlIG9uY2U=",
  "encoding": "BASE64",
  "file_name": "resume.pdf",
  "content_type": "application/pdf"
}

Properties

nameString

Required

The name of the form field

dataString

Required

The data for the form field.

encodingEnum

Optional

The encoding of the value of data. Defaults to RAW if not defined. Possible values include: RAW, BASE64, GZIP_BASE64.

file_nameString

Optional

The file name of the form field, if the field is for a file.

content_typeString

Optional

The MIME type of the file, if the field is for a file.

headersObject

Optional

The headers to use for the request (Merge will handle the account's authorization headers). Content-Type header is required for passthrough. Choose content type corresponding to expected format of receiving server.

request_formatEnum

Optional

Must pass in one of the following choices: JSON, XML, MULTIPART.

normalize_responseBoolean

Required

Optional. If true, the response will always be an object of the form {"type": T, "value": ...} where T will be one of string, boolean, number, null, array, object.

POST v1/passthrough

JSON


{
  "method": "POST",
  "path": "/scooters",
  "base_url_override": "string",
  "data": "{\"company\": \"Lime\", \"model\": \"Gen 2.5\"}",
  "multipart_form_data": [
    {
      "name": "resume",
      "data": "SW50ZWdyYXRlIGZhc3QKSW50ZWdyYXRlIG9uY2U=",
      "encoding": "BASE64",
      "file_name": "resume.pdf",
      "content_type": "application/pdf"
    }
  ],
  "headers": {
    "EXTRA-HEADER": "value"
  },
  "request_format": "JSON",
  "normalize_response": true
}

Response

JSON


{
  "method": "GET",
  "path": "/scooters",
  "status": 200,
  "response": {
    "scooters": [
      {
        "company": "Lime",
        "model": "Gen 2.5"
      },
      {
        "company": "Bird",
        "model": "Bird Zero"
      }
    ]
  },
  "response_headers": {
    "X-Page-Token": "value"
  },
  "response_type": "JSON",
  "headers": {
    "EXTRA-HEADER": "value",
    "Authorization": "<redacted>"
  }
}