Skip to main content
POST
/
v1
/
treatment-groups
Create a treatment group
curl --request POST \
  --url https://dev.flextell.ai/api/v1/treatment-groups \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Tenant: <x-tenant>' \
  --data '
{
  "name": "<string>",
  "is_active": true,
  "description": "<string>",
  "total_price": 1,
  "is_price_manual": true,
  "treatment_ids": [
    123
  ]
}
'
{
  "success": "<string>",
  "data": {
    "id": 123,
    "name": "<string>",
    "description": "<string>",
    "total_price": "<string>",
    "effective_price": "<string>",
    "is_price_manual": true,
    "is_active": true,
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "deleted_at": "2023-11-07T05:31:56Z",
    "treatments": [
      {
        "id": 123,
        "group_id": 123,
        "name": "<string>",
        "keywords": [
          "<unknown>"
        ],
        "price": "<string>",
        "tax_rate": 123,
        "description": "<string>",
        "session": 123,
        "is_active": "<string>",
        "extra_info": {},
        "created_at": "2023-11-07T05:31:56Z",
        "updated_at": "2023-11-07T05:31:56Z",
        "deleted_at": "2023-11-07T05:31:56Z",
        "group": {
          "id": 123,
          "name": "<string>",
          "is_active": true
        },
        "users": [
          {
            "id": 123,
            "name": "<string>"
          }
        ],
        "sessions": [
          {
            "id": 123,
            "session_order": 123,
            "next_gap_days": 123,
            "offset_days": 123,
            "products": [
              {
                "id": 123,
                "product_id": 123,
                "min_quantity": 123,
                "product": {
                  "id": 123,
                  "name": "<string>",
                  "full_name": "<string>",
                  "brand": {
                    "id": 123,
                    "name": "<string>"
                  },
                  "unit_code": {
                    "id": "<string>",
                    "name": "<string>",
                    "code": "<string>"
                  }
                }
              }
            ]
          }
        ]
      }
    ]
  }
}

Authorizations

​
Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

​
X-Tenant
number
required

Tenant identifier. Send the Tenant ID in the X-Tenant header to scope API requests to a specific tenant.

Body

application/json
​
name
string
required

Group name.

Maximum string length: 255
​
is_active
boolean
required

Active status.

​
description
string | null

Group description.

​
total_price
number | null

Total price for the group.

Required range: x >= 0
​
is_price_manual
boolean | null

Whether the price is manually set (not auto-calculated from treatments).

​
treatment_ids
integer[] | null

Treatment IDs to assign to this group.

A treatment ID.

Response

​
success
string
required
​
data
TreatmentGroupResource · object
required