Create Filter Segment

POST

/api/:account_id/filter-segments/

POST

/api/:account_id/filter-segments/

$ curl -X POST https://app.paymentkit.com/api/account_id/filter-segments/ \
>      -H "Authorization: Bearer <token>" \
>      -H "Content-Type: application/json" \
>      -d '{
>   "module": "subscriptions",
>   "name": "Active Premium Users",
>   "filters": [
>     {
>       "type": "subscription_status",
>       "id": "active",
>       "label": "Active"
>     },
>     {
>       "type": "plan_type",
>       "id": "premium",
>       "label": "Premium Plan"
>     }
>   ]
> }'

1 {
2   "id": "f47ac10b-58cc-4372-a567-0e02b2c3d479",
3   "module": "subscriptions",
4   "name": "Active Premium Users",
5   "filters": [
6     {
7       "type": "subscription_status",
8       "id": "active",
9       "label": "Active"
10     },
11     {
12       "type": "plan_type",
13       "id": "premium",
14       "label": "Premium Plan"
15     }
16   ],
17   "created_by_user_id": "user_12345",
18   "created_at": "2024-01-15T09:30:00Z",
19   "updated_at": "2024-01-15T09:30:00Z"
20 }

Save a new filter segment.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

account_idstringRequired

Request

This endpoint expects an object.

modulestringRequired1-64 characters

Module key identifying which page the segment belongs to

namestringRequired1-80 characters

User-provided segment name

filterslist of objectsRequired

Filter predicates to save

Response

Successful Response

idstring

modulestring

namestring

filterslist of objects

created_by_user_idstring or null

created_atdatetime

updated_atdatetime

Errors

422

Unprocessable Entity Error