| Field | Type | Required | Description | Example |
|---|---|---|---|---|
consumerId |
Optional<String> | ➖ | ID of the consumer which you want to get or push data from | test-consumer |
appId |
Optional<String> | ➖ | The ID of your Unify application | dSBdXd2H6Mqwfg0atXHXYcysLJE9qyn1VwBtXHX |
serviceId |
String | ✔️ | Provide the service id you want to call (e.g., pipedrive). Only needed when a consumer has activated multiple integrations for a Unified API. | close |
unifiedApi |
Optional<String> | ➖ | Specify which unified API to use for the connection lookup. Required for multi-API connectors (e.g., Workday) to ensure the correct credentials are used. | hris |
downstreamUrl |
String | ✔️ | Downstream URL | https://api.close.com/api/v1/lead |
downstreamAuthorization |
Optional<String> | ➖ | Downstream authorization header. This will skip the Vault token injection. | Bearer |
timeout |
Optional<Long> | ➖ | Override the default downstream request timeout in milliseconds. The default is 28000 (28 seconds). | 30000 |
followRedirects |
Optional<Boolean> | ➖ | Set to false to opt out of the redirect to the presigned download URL. Instead of a 30x response, you receive a 200 JSON body { url, expires_at } containing the URL and its expiry, which you can fetch explicitly. Use this if your client automatically forwards the Authorization header onto redirects, since the downstream storage provider will reject that request. Any value other than false (or omitting the header) preserves the default redirect behavior. |
false |
requestBody |
byte[] | ➖ | Depending on the verb/method of the request this will contain the request body you want to POST/PATCH/PUT. |