---
title: Create a destination
description: "Always creates a new destination; the server assigns the id used for every subsequent lookup. display name is not an identity key, so repeating a create make…"
product: general
lang: en
last_updated: 2026-09-15
token_estimate: 2584
---
# Create a destination

> For AI agents: a documentation index is available at [/docs/llms.txt](/docs/llms.txt). Append `.md` to any page URL for markdown, or send `Accept: text/markdown`.

## Create a destination

**POST** `/v1/projects/{project_id}/destinations`

Full URL: `https://developer-api.amplitude.com/v1/projects/{project_id}/destinations`

**Servers:**
- Production (US): `https://developer-api.amplitude.com/v1/projects/{project_id}/destinations`
- Production (EU): `https://developer-api.eu.amplitude.com/v1/projects/{project_id}/destinations`

Create a destination

Always creates a new destination; the server assigns the `id` used for
every subsequent lookup. `display_name` is not an identity key, so
repeating a create makes another destination. When `dry_run=true`, returns
a plan envelope without mutating. SECRET/OAUTH config values are
write-only.

## Authorizations

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| Authorization | string | Yes | — | http |

## Path parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| project_id (path) | string | Yes | 12345 | Amplitude project identifier, backed by the canonical app ID. Constraints: pattern: ^[0-9]+$ |

## Query parameters

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| dry_run (query) | boolean | No | false | Validate request without performing mutation. |

## Body (application/json)

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| partner | string | Yes | — | — |
| display_name | string | Yes | — | Constraints: min length: 1 |
| kind | string[] | No | — | Optional connector kinds. When omitted, the kind is inferred from the partner's capabilities; a multi-capability partner with no kind is rejected as ambiguous. When provided it is authoritative and validated against the partner. The three families are mutually exclusive: a subset of [event, identify], or [cohort], or [warehouse_export] — never combined. |
| config | object | No | — | — |
| enabled | boolean | No | — | — |
| event_filter | object | No | — | — |
| event_filter.events | string[] | Yes | — | — |
| event_filter.property_filters | object | No | — | — |
| property_mappings | object | No | — | — |
| send_events | boolean | No | — | — |
| send_users | boolean | No | — | — |

## Response (application/json)

**200** — Dry-run plan (no mutation).

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| data | object | Yes | — | — |
| data.id | string | Yes | — | Server-assigned identifier (read-only). |
| data.object | string | Yes | — | — |
| data.project_id | string | Yes | — | Constraints: pattern: ^[0-9]+$ |
| data.partner | string | Yes | — | — |
| data.display_name | string | Yes | — | — |
| data.kind | string[] | Yes | — | — |
| data.config | object | Yes | — | Partner config keyed by parameter id. SECRET/OAUTH values are write-only and never returned on reads. Values are scalars or structured (objects/arrays, e.g. header maps); structured values round-trip as decoded JSON. |
| data.credential_status | string | Yes | — | Allowed values: connected, disconnected, expired |
| data.version | integer | Yes | — | Constraints: min: 1 |
| data.enabled | boolean | No | — | Event-streaming only. Whether the stream is enabled. |
| data.paused | boolean | No | — | Event-streaming only. Whether the stream is paused. |
| data.event_filter | oneOf | No | — | Event-streaming only. Events (and optional property filters) to stream. Constraints: object, null |
| data.event_filter.events | string[] | No | — | — |
| data.event_filter.property_filters | object | No | — | — |
| data.property_mappings | oneOf | No | — | Event-streaming only. Optional property mappings. Constraints: object, null |
| data.send_events | boolean | No | — | Event-streaming only. Whether to send events. |
| data.send_users | boolean | No | — | Event-streaming only. Whether to send identify/user updates. |
| data.created_at | string | Yes | — | Constraints: format: date-time |
| data.updated_at | string | Yes | — | Constraints: format: date-time |
| data.created_by | string | No | — | Constraints: nullable |
| data.updated_by | string | No | — | Constraints: nullable |
| plan | object | Yes | — | — |
| plan.action | string | Yes | — | Allowed values: create, update, noop |
| plan.dry_run | boolean | Yes | — | — |
| plan.diff | oneOf | No | — | Constraints: object, null |
| plan.warnings | string[] | No | — | — |

```json
{
  "data": {
    "id": "string",
    "object": "destination",
    "project_id": "string",
    "partner": "string",
    "display_name": "string",
    "kind": [
      "event"
    ],
    "config": {},
    "credential_status": "connected",
    "version": 1,
    "enabled": true,
    "paused": true,
    "event_filter": {
      "events": [
        "string"
      ],
      "property_filters": {}
    },
    "property_mappings": {},
    "send_events": true,
    "send_users": true,
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "created_by": "string",
    "updated_by": "string"
  },
  "plan": {
    "action": "create",
    "dry_run": true,
    "diff": {},
    "warnings": [
      "string"
    ]
  }
}
```

**201** — Destination created.

| Name | Type | Required | Default | Description |
| --- | --- | --- | --- | --- |
| data | object | Yes | — | — |
| data.id | string | Yes | — | Server-assigned identifier (read-only). |
| data.object | string | Yes | — | — |
| data.project_id | string | Yes | — | Constraints: pattern: ^[0-9]+$ |
| data.partner | string | Yes | — | — |
| data.display_name | string | Yes | — | — |
| data.kind | string[] | Yes | — | — |
| data.config | object | Yes | — | Partner config keyed by parameter id. SECRET/OAUTH values are write-only and never returned on reads. Values are scalars or structured (objects/arrays, e.g. header maps); structured values round-trip as decoded JSON. |
| data.credential_status | string | Yes | — | Allowed values: connected, disconnected, expired |
| data.version | integer | Yes | — | Constraints: min: 1 |
| data.enabled | boolean | No | — | Event-streaming only. Whether the stream is enabled. |
| data.paused | boolean | No | — | Event-streaming only. Whether the stream is paused. |
| data.event_filter | oneOf | No | — | Event-streaming only. Events (and optional property filters) to stream. Constraints: object, null |
| data.event_filter.events | string[] | No | — | — |
| data.event_filter.property_filters | object | No | — | — |
| data.property_mappings | oneOf | No | — | Event-streaming only. Optional property mappings. Constraints: object, null |
| data.send_events | boolean | No | — | Event-streaming only. Whether to send events. |
| data.send_users | boolean | No | — | Event-streaming only. Whether to send identify/user updates. |
| data.created_at | string | Yes | — | Constraints: format: date-time |
| data.updated_at | string | Yes | — | Constraints: format: date-time |
| data.created_by | string | No | — | Constraints: nullable |
| data.updated_by | string | No | — | Constraints: nullable |

```json
{
  "data": {
    "id": "string",
    "object": "destination",
    "project_id": "string",
    "partner": "string",
    "display_name": "string",
    "kind": [
      "event"
    ],
    "config": {},
    "credential_status": "connected",
    "version": 1,
    "enabled": true,
    "paused": true,
    "event_filter": {
      "events": [
        "string"
      ],
      "property_filters": {}
    },
    "property_mappings": {},
    "send_events": true,
    "send_users": true,
    "created_at": "2024-01-01T00:00:00Z",
    "updated_at": "2024-01-01T00:00:00Z",
    "created_by": "string",
    "updated_by": "string"
  }
}
```

**400**

**401**

**403**

**404**

**422**

**429**

**500**

## Code samples

### cURL

```bash
curl -X POST "https://developer-api.amplitude.com/v1/projects/12345/destinations?dry_run=false" \
  -H "Content-Type: application/json" \
  -H "Authorization: YOUR_API_KEY"
```

### Python

```python
import requests

response = requests.post(
    "https://developer-api.amplitude.com/v1/projects/12345/destinations?dry_run=false",
    headers={
        "Content-Type": "application/json",
        "Authorization": "YOUR_API_KEY"
    }
)
data = response.json()
```

### JavaScript

```javascript
const response = await fetch("https://developer-api.amplitude.com/v1/projects/12345/destinations?dry_run=false", {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "YOUR_API_KEY"
  }
});
const data = await response.json();
```

### PHP

```php
<?php
$ch = curl_init("https://developer-api.amplitude.com/v1/projects/12345/destinations?dry_run=false");
curl_setopt($ch, CURLOPT_CUSTOMREQUEST, "POST");
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    "Content-Type: application/json",
    "Authorization: YOUR_API_KEY"
]);
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
```

### Go

```go
package main

import (
  "bytes"
  "net/http"
)

func main() {
req, _ := http.NewRequest("POST", "https://developer-api.amplitude.com/v1/projects/12345/destinations?dry_run=false", nil)
req.Header.Set("Content-Type", "application/json")
req.Header.Set("Authorization", "YOUR_API_KEY")
  client := &http.Client{}
  resp, _ := client.Do(req)
  defer resp.Body.Close()
}
```

### Java

```java
HttpClient client = HttpClient.newHttpClient();
HttpRequest request = HttpRequest.newBuilder()
      .uri(URI.create("https://developer-api.amplitude.com/v1/projects/12345/destinations?dry_run=false"))
      .method("POST", HttpRequest.BodyPublishers.noBody())
.header("Content-Type", "application/json")
      .header("Authorization", "YOUR_API_KEY")
      .build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
```

### Ruby

```ruby
require "net/http"
require "json"

uri = URI("https://developer-api.amplitude.com/v1/projects/12345/destinations?dry_run=false")
request = Net::HTTP::Post.new(uri)
request["Content-Type"] = "application/json"
request["Authorization"] = "YOUR_API_KEY"
response = Net::HTTP.start(uri.hostname, uri.port, use_ssl: uri.scheme == "https") do |http|
  http.request(request)
end
```