Skip to content

Update Destination

PATCH
/api/audience-destinations/{destination_id}
curl --request PATCH \
--url http://localhost:8000/api/audience-destinations/example \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "config": {}, "enabled": true, "field_map": { "additionalProperty": "example" }, "name": "example" }'
destination_id
required
Destination Id
string
x-workspace-id
Any of:
string
Media typeapplication/json
DestinationPatch
object
config
Any of:
object
key
additional properties
any
enabled
Any of:
boolean
field_map
Any of:
object
key
additional properties
string
name
Any of:
string
>= 1 characters <= 200 characters
Examplegenerated
{
"config": {},
"enabled": true,
"field_map": {
"additionalProperty": "example"
},
"name": "example"
}

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