Data managementAsync passthrough

/async-passthrough

Asynchronously pull data from an endpoint not currently supported by Merge.

Authentication

AuthorizationBearer

Token-based authentication with required prefix “Bearer”

Headers

X-Account-TokenstringRequired
Token identifying the end user.

Request

This endpoint expects an object.
methodenumRequired
  • GET - GET
  • OPTIONS - OPTIONS
  • HEAD - HEAD
  • POST - POST
  • PUT - PUT
  • PATCH - PATCH
  • DELETE - DELETE
pathstringRequired>=1 character
The path of the request in the third party's platform.
base_url_overridestring or nullOptional>=1 character
An optional override of the third party's base url for the request.
datastring or nullOptional>=1 character

The data with the request. You must include a request_format parameter matching the data’s format

multipart_form_datalist of objects or nullOptional

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

headersmap from strings to any or nullOptional

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 or nullOptional
  • JSON - JSON
  • XML - XML
  • MULTIPART - MULTIPART
Allowed values:
normalize_responsebooleanOptional

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.

Response

async_passthrough_receipt_idstringformat: "uuid"