POST /grid-segments

Creates a new UI segment for yourself or to share with others within your organization.

Servers

https://api-sandbox.rebilly.com/organizations/{organizationId}
https://api.rebilly.com/organizations/{organizationId}

Request headers

Name	Type	Required	Description
`Content-Type`	String	Yes	The media type of the request body. Default value: "application/json"

Request body fields

Name	Type	Required	Description
`id`	String	No	ID of the segment.
`data`	Object	Yes	Object that contains a schema that is used to set up the UI for the segment. This schema is built and consumed by the frontend. It includes information such as: segment name, UI settings, and so on.
`data.filters`	String	No	Combination of filters to apply on grid segment data.
`data.page`	String	No	Where to display grid segment: data tables or customer details. Valid values: `"data-tables"` `"customer-details"`
`data.name`	String	No	Name of data grid segment.
`data.sort`	String	No	Column to sort data by. To sort in descending order, prefix with `-`.
`data.columns[]`	Array	No	List of columns to display in grid segment.
`data.type`	String	No	Data to display in grid segment. Valid values: `"credit-memos"` `"deposit-requests"` `"coupon-redemptions"` `"subscriptions"` `"organizations"` `"transactions"` `"payout-requests"` `"aml"` `"payout-request-batches"` `"quotes"` `"invoices"` `"journal-entry"` `"payout-allocations"` `"customers"` `"orders"` `"api-logs"` `"webhook-logs"` `"tax-logs"` `"kyc"`
`isStarred`	Boolean	No	Specifies if this segment is starred by the current user. Starring a segment marks it as a favorite segment, and also adds the segment to a starred folder in the UI.
`systemId`	String	No	If the segment is derived from a system segment, this field contains the ID of the related system segment. To provide this field in a request, the `scope` field must be set to `private` .
`userIds[]`	Array	No	List of user IDs with which the segment is shared. This field is used when the `scope` field is set to `shared`.
`scope`	String	Yes	Controls the visibility of the segment. Valid values: `"shared"` `"public"` `"private"`
`owner`	Object	Yes	Creator of segment.
`owner.id`	String	No	ID of the user.
`owner.name`	String	No	First and last name of the creator.
`users[]`	Array	No	List of user details with which this segment is shared.
`users[].id`	String	No	ID of the user.
`users[].name`	String	No	First and last name.
`isVisible`	Boolean	No	Specifies if the segment is visible to the current user.

How to start integrating

Add HTTP Task to your workflow definition.
Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
Click Test request to test run your request to the API and see the API's response.