Skip to content
OpenGTM

Create Destination

POST
/api/audience-destinations
curl --request POST \
  --url http://localhost:8000/api/audience-destinations \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "audience_id": "example", "config": {}, "destination_type": "example", "enabled": true, "field_map": { "additionalProperty": "example" }, "name": "example" }'

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
DestinationCreate
object
audience_id
required
Audience Id
string
config
Config
object
key
additional properties
any
destination_type
required
Destination Type
string
enabled
Enabled
boolean
default: true
field_map
Field Map
object
key
additional properties
string
name
required
Name
string
>= 1 characters <= 200 characters

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