Skip to content

Update Audience

PATCH
/api/audiences/{audience_id}
curl --request PATCH \
--url http://localhost:8000/api/audiences/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "description": "example", "filters": {}, "name": "example", "refresh_enabled": true, "refresh_interval_minutes": 1 }'
audience_id
required
Audience Id
string
x-workspace-id
Any of:
string
Media typeapplication/json
AudiencePatch
object
description
Any of:
string
<= 2000 characters
filters
Any of:
object
key
additional properties
any
name
Any of:
string
>= 1 characters <= 200 characters
refresh_enabled
Any of:
boolean
refresh_interval_minutes
Any of:
integer
>= 15 <= 10080
Examplegenerated
{
"description": "example",
"filters": {},
"name": "example",
"refresh_enabled": true,
"refresh_interval_minutes": 1
}

Successful Response

Media typeapplication/json
Examplegenerated
example

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"
}
]
}