Create group

Use when organizing entities into a group (e.g. for filtering prices or plans by product line or region).

POST /groups

Create group

cURL

curl --request POST \
  --url https://us.api.flexprice.io/v1/groups \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "entity_type": "<string>",
  "lookup_key": "<string>",
  "name": "<string>"
}
'

201

{
  "created_at": "2023-11-07T05:31:56Z",
  "entity_ids": [
    "<string>"
  ],
  "entity_type": "<string>",
  "id": "<string>",
  "lookup_key": "<string>",
  "metadata": {},
  "name": "<string>",
  "status": "<string>",
  "updated_at": "2023-11-07T05:31:56Z"
}

Authorizations

x-api-key · string · header · required

Enter your API key in the format x-api-key <api-key>*

Body

application/json

Group

entity_type · string · required

lookup_key · string · required

name · string · required

Response

201

application/json

Created

created_at · string<date-time>

entity_ids · string[]

entity_type · string

id · string

lookup_key · string

metadata · object

Show child attributes

name · string

status · string

updated_at · string<date-time>