Create a group - Flexprice

POST

/

groups

Create a group

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

{
  "created_at": "<string>",
  "entity_ids": [
    "<string>"
  ],
  "entity_type": "<string>",
  "id": "<string>",
  "lookup_key": "<string>",
  "metadata": {},
  "name": "<string>",
  "status": "<string>",
  "updated_at": "<string>"
}

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

Created

created_at

string

entity_ids

string[]

entity_type

string

id

string

lookup_key

string

metadata

object

Show child attributes

name

string

status

string

updated_at

string

Get groupsGet groups with optional filtering via query parameters

⌘I

Create a group

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

{
  "created_at": "<string>",
  "entity_ids": [
    "<string>"
  ],
  "entity_type": "<string>",
  "id": "<string>",
  "lookup_key": "<string>",
  "metadata": {},
  "name": "<string>",
  "status": "<string>",
  "updated_at": "<string>"
}