ℹ️
Instructions
When preparing your API requests, carefully review the segments array which includes sub-objects with specific properties. This attention to detail will ensure accurate data handling during your interactions with the API.
Additionally, ensure your request includes the necessary headers. To test the request directly on the platform:

Scroll down to the HEADERS section below the Request Body section.

Enter the "Content-Type" header with the value "application/json".

Include your "Authorization" token using either Basic Auth or JWT Access Token. For detailed instructions on obtaining these tokens, refer to the documentation on Obtaining your API key and company ID and Obtaining your JWT token.

Enter the values for the fields in your Request Body section below.

Click the "Try It!" button at the top-right of your screen to initiate the request and view your response.

❗️
Sample Request and Response
To see a sample request and response, click the "EXAMPLES" dropdown at the top-right of your screen.

Request Body

The request should include the following parameters. Enter your values in the input field(s) below for testing: