Skip to content
OpenGTM

Create Audience

POST
/api/audiences
curl --request POST \
  --url http://localhost:8000/api/audiences \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "description": "", "filters": {}, "name": "example", "refresh_enabled": true, "refresh_interval_minutes": 60 }'

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Header Parameters

Section titled “Header Parameters”
x-workspace-id
Any of:
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
AudienceCreate
object
description
Description
string
"" <= 2000 characters
filters
Filters
object
key
additional properties
any
name
required
Name
string
>= 1 characters <= 200 characters
refresh_enabled
Refresh Enabled
boolean
default: true
refresh_interval_minutes
Refresh Interval Minutes
integer
default: 60 >= 15 <= 10080

Responses

Section titled “Responses”

201

Section titled “201”

Successful Response

Media typeapplication/json
Examplegenerated
example

422

Section titled “422”

Validation Error

Media typeapplication/json
HTTPValidationError
object
detail
Detail
Array<object>
ValidationError
object
ctx
Context
object
input
Input
loc
required
Location
Array
msg
required
Message
string
type
required
Error Type
string
Examplegenerated
{
  "detail": [
    {
      "ctx": {},
      "input": "example",
      "loc": [
        "example"
      ],
      "msg": "example",
      "type": "example"
    }
  ]
}