patch()

Description

PATCH data to an integration endpoint.

By default the Content-Type is set to application/json, but you can override this value by passing your own headers in the integration() method.

Request

Parameters

FieldRequiredData TypeDescription

path

string

The path of the integration endpoint. You can find it by downloading the postman collection for the integration from the API Docs page. Example: Stripe Customers Endpoint is "/customers".

body

Object

Data to be sent to the integration

Examples

PATCH without custom headers

const results = await client.integration("stripe").patch("/customers", JSON.stringify({ email: "customer@email.com" }));

PATCH with custom headers

const results = await client.integration("stripe", { "Content-Type": "application/x-www-form-urlencoded" }).patch("/customers", JSON.stringify({ email: "customer@email.com" }));

Response

Response schema is defined by the integration you are activating. Deskree passes the entire object received by the integration.

Last updated