DataPassthroughRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/DataPassthroughRequest",
  "title": "DataPassthroughRequest",
  "type": "object",
  "properties": {
    "method": {
      "$ref": "#/components/schemas/MethodEnum"
    },
    "path": {
      "type": "string",
      "description": "The path of the request in the third party's platform."
    },
    "base_url_override": {
      "type": [
        "string",
        "null"
      ],
      "description": "An optional override of the third party's base url for the request."
    },
    "data": {
      "type": [
        "string",
        "null"
      ],
      "description": "The data with the request. You must include a `request_format` parameter matching the data's format"
    },
    "multipart_form_data": {
      "type": [
        "array",
        "null"
      ],
      "items": {
        "$ref": "#/components/schemas/MultipartFormFieldRequest"
      },
      "description": "Pass an array of `MultipartFormField` objects in here instead of using the `data` param if `request_format` is set to `MULTIPART`."
    },
    "headers": {
      "type": [
        "object",
        "null"
      ],
      "additionalProperties": {
        "description": "Any type"
      },
      "description": "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_format": {
      "oneOf": [
        {
          "$ref": "#/components/schemas/RequestFormatEnum"
        },
        {
          "type": "null"
        }
      ]
    },
    "normalize_response": {
      "type": "boolean",
      "description": "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`."
    }
  },
  "required": [
    "method",
    "path"
  ],
  "description": "# The DataPassthrough Object\n### Description\nThe `DataPassthrough` object is used to send information to an otherwise-unsupported third-party endpoint.\n\n### Usage Example\nCreate a `DataPassthrough` to get team hierarchies from your Rippling integration."
}