> This page is for version v2 (default).
> For other versions, use one of these documentation indexes:
> - v2 (default): https://docs.pinnacle.sh/v-2/llms.txt
> - v1: https://docs.pinnacle.sh/v1/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.pinnacle.sh/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.pinnacle.sh/_mcp/server.

# Add Participant

POST https://api.pinnacle.sh/conferences/{id}/participants
Content-Type: application/json

Add someone: dial a new number (`to` + `from`) or pull in a call you already have (`call_id`).

A dialed participant is returned with status `dialing` and joins when they answer; you'll get `participant.joined` (or `participant.failed` if they don't answer). With `announce`, they hear it alone before joining.


Reference: https://docs.pinnacle.sh/api-reference/conferences/participants/add-participant

## Authentication

- `PINNACLE-API-KEY` header (required) — API Key authentication via header

## Request

### Path parameters

- `id` (string, required)

### Headers

- `Idempotency-Key` (string, optional) — Makes dialing safe to retry; the number is dialed at most once.

### Body (application/json)

This endpoint expects an AddParticipantParams.

- `AddParticipantParams`

## Response

### 201

Participant added.

- `call_id` (string, required) — The participant is this call; every call API works on it.
- `conference_id` (string, required)
- `label` (string, required, nullable)
- `status` (enum, required) — - `dialing`: A dialed participant whose call hasn't answered yet. - `ringing`: Answered and being connected (or hearing its `announce`). - `joined`: In the conference. - `left`: Hung up or was removed. - `failed`: Never connected (busy, no answer, rejected, or an error).
  - Allowed values: `dialing`, `ringing`, `joined`, `left`, `failed`
- `from` (string, required, nullable)
- `to` (string, required, nullable)
- `muted` (boolean, required) — Nobody hears this participant; they still hear everyone.
- `on_hold` (boolean, required) — They hear hold audio and nobody hears them.
- `whisper_to` (list of string, required, nullable) — Call IDs of the only participants who can hear this one, or `null` for everyone.
- `end_conference_on_leave` (boolean, required) — When this participant leaves, the conference ends for everyone.
- `joined_at` (string, required, nullable)
- `left_at` (string, required, nullable)
- `left_reason` (enum, required, nullable)
  - Allowed values: `hangup`, `removed`, `busy`, `no_answer`, `rejected`, `failed`, `conference_ended`

## Errors

### 400 Bad Request Error

Validation failed. The payload has missing required fields and/or invalid types.  See [https://zod.dev/error-formatting](https://zod.dev/error-formatting) for more information.

- `description` (string, required) — Human-readable summary of validation failures.
- `errors` (ZodErrorErrors, required) — Structured dictionary of issues containing two main sections: - `errors`: Array of global validation errors not tied to specific fields - `properties`: Object mapping field names to their specific validation errors, where each field contains an `errors` array

### 401 Unauthorized Error

The request lacks valid authentication credentials or the provided credentials are invalid.  Ensure you're including a valid API key in the request headers and that your account has the necessary permissions to access this endpoint.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

### 404 Not Found Error

The requested resource could not be found.  This may occur if the identifier is incorrect, the resource has been deleted, or you don't have permission to access it.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

### 409 Conflict Error

The conference has ended or is full, the label is taken, or the call isn't answered or is already in a conference.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

### 500 Internal Server Error

An unexpected error occurred on Pinnacle's servers while processing your request.  If this error persists, please contact support with the request details.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

### 502 Bad Gateway Error

One of Pinnacle's providers failed. Please try again later.

- `error` (string, required) — Human-readable description of the error that occurred, corresponding to the HTTP status code.

## Types

### DialParticipantParams

Dial someone new. This creates a new outbound call, exactly like `POST /calls`.

- `to` (string, required) — E.164 number to dial.
- `from` (string, required) — One of your voice-enabled numbers.
- `label` (string, optional) — A name you choose for the participant, unique within the conference. Anywhere a participant is referenced you can use its label instead of its `call_id`. Can't start with `call_` or `leg_`.
- `muted` (boolean, optional)
- `on_hold` (boolean, optional)
- `whisper_to` (list of string, optional) — Only these participants (call IDs or labels) can hear this one; it still hears everyone. `null` means everyone hears it (the default). Stored as call IDs, so relabeling someone doesn't change who hears a whisper.
- `end_conference_on_leave` (boolean, optional)
- `announce` (Announce, optional) — Played to a dialed participant when they answer, before they join. Nobody else hears it. If it can't be played, they join without it.
- `ring_timeout_secs` (integer, optional)
- `record` (boolean, optional) — Same as `record` on `POST /calls`.
- `metadata` (map from string to string, optional) — String metadata carried on future call events. Maximum serialized size is 2 KB.

### ExistingCallParticipantParams

Pull in a call your team already has. It must be answered and not in another conference.

- `call_id` (string, required)
- `label` (string, optional) — A name you choose for the participant, unique within the conference. Anywhere a participant is referenced you can use its label instead of its `call_id`. Can't start with `call_` or `leg_`.
- `muted` (boolean, optional)
- `on_hold` (boolean, optional)
- `whisper_to` (list of string, optional) — Only these participants (call IDs or labels) can hear this one; it still hears everyone. `null` means everyone hears it (the default). Stored as call IDs, so relabeling someone doesn't change who hears a whisper.
- `end_conference_on_leave` (boolean, optional)

### ZodErrorErrors

Structured dictionary of issues containing two main sections: - `errors`: Array of global validation errors not tied to specific fields - `properties`: Object mapping field names to their specific validation errors, where each field contains an `errors` array

### Announce

Played to a dialed participant when they answer, before they join. Nobody else hears it. If it can't be played, they join without it.

### Speak

- `text` (string, required)
- `voice` (string, optional) — Text-to-speech voice. Defaults to `AWS.Polly.Joanna`.

### Play

- `url` (string, required) — Public `https` URL of an audio file.

## Examples

### ExistingCall

**Request**

```json
{
  "call_id": "call_7cQe4F8xT1yB2mN9pK3L",
  "label": "caller"
}
```

**Response**

```json
{
  "call_id": "call_7cQe4F8xT1yB2mN9pK3L",
  "conference_id": "conf_Hk2mX9pQ4rT7vB1nL8sW",
  "label": "supervisor",
  "status": "dialing",
  "from": "+14155559876",
  "to": "+14155551234",
  "muted": true,
  "on_hold": true,
  "whisper_to": [
    "string"
  ],
  "end_conference_on_leave": true,
  "joined_at": "2024-01-15T09:30:00Z",
  "left_at": "2024-01-15T09:30:00Z",
  "left_reason": "hangup"
}
```

**SDK Code**

```python ExistingCall
import requests

url = "https://api.pinnacle.sh/conferences/id/participants"

payload = {
    "call_id": "call_7cQe4F8xT1yB2mN9pK3L",
    "label": "caller"
}
headers = {
    "PINNACLE-API-KEY": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript ExistingCall
const url = 'https://api.pinnacle.sh/conferences/id/participants';
const options = {
  method: 'POST',
  headers: {'PINNACLE-API-KEY': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"call_id":"call_7cQe4F8xT1yB2mN9pK3L","label":"caller"}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go ExistingCall
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pinnacle.sh/conferences/id/participants"

	payload := strings.NewReader("{\n  \"call_id\": \"call_7cQe4F8xT1yB2mN9pK3L\",\n  \"label\": \"caller\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("PINNACLE-API-KEY", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby ExistingCall
require 'uri'
require 'net/http'

url = URI("https://api.pinnacle.sh/conferences/id/participants")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["PINNACLE-API-KEY"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"call_id\": \"call_7cQe4F8xT1yB2mN9pK3L\",\n  \"label\": \"caller\"\n}"

response = http.request(request)
puts response.read_body
```

```java ExistingCall
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.pinnacle.sh/conferences/id/participants")
  .header("PINNACLE-API-KEY", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"call_id\": \"call_7cQe4F8xT1yB2mN9pK3L\",\n  \"label\": \"caller\"\n}")
  .asString();
```

```php ExistingCall
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.pinnacle.sh/conferences/id/participants', [
  'body' => '{
  "call_id": "call_7cQe4F8xT1yB2mN9pK3L",
  "label": "caller"
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'PINNACLE-API-KEY' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp ExistingCall
using RestSharp;

var client = new RestClient("https://api.pinnacle.sh/conferences/id/participants");
var request = new RestRequest(Method.POST);
request.AddHeader("PINNACLE-API-KEY", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"call_id\": \"call_7cQe4F8xT1yB2mN9pK3L\",\n  \"label\": \"caller\"\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift ExistingCall
import Foundation

let headers = [
  "PINNACLE-API-KEY": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "call_id": "call_7cQe4F8xT1yB2mN9pK3L",
  "label": "caller"
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.pinnacle.sh/conferences/id/participants")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Example 2

**Request**

```json
{
  "to": "+14155551234",
  "from": "+14155559876",
  "label": "supervisor",
  "muted": true,
  "announce": {
    "text": "You're joining a billing call. You're muted."
  }
}
```

**Response**

```json
{
  "call_id": "call_7cQe4F8xT1yB2mN9pK3L",
  "conference_id": "conf_Hk2mX9pQ4rT7vB1nL8sW",
  "label": "supervisor",
  "status": "dialing",
  "from": "+14155559876",
  "to": "+14155551234",
  "muted": true,
  "on_hold": true,
  "whisper_to": [
    "string"
  ],
  "end_conference_on_leave": true,
  "joined_at": "2024-01-15T09:30:00Z",
  "left_at": "2024-01-15T09:30:00Z",
  "left_reason": "hangup"
}
```

**SDK Code**

```python
import requests

url = "https://api.pinnacle.sh/conferences/id/participants"

payload = {
    "to": "+14155551234",
    "from": "+14155559876",
    "label": "supervisor",
    "muted": True,
    "announce": { "text": "You're joining a billing call. You're muted." }
}
headers = {
    "PINNACLE-API-KEY": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.pinnacle.sh/conferences/id/participants';
const options = {
  method: 'POST',
  headers: {'PINNACLE-API-KEY': '<apiKey>', 'Content-Type': 'application/json'},
  body: '{"to":"+14155551234","from":"+14155559876","label":"supervisor","muted":true,"announce":{"text":"You\'re joining a billing call. You\'re muted."}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.pinnacle.sh/conferences/id/participants"

	payload := strings.NewReader("{\n  \"to\": \"+14155551234\",\n  \"from\": \"+14155559876\",\n  \"label\": \"supervisor\",\n  \"muted\": true,\n  \"announce\": {\n    \"text\": \"You're joining a billing call. You're muted.\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("PINNACLE-API-KEY", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.pinnacle.sh/conferences/id/participants")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["PINNACLE-API-KEY"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"to\": \"+14155551234\",\n  \"from\": \"+14155559876\",\n  \"label\": \"supervisor\",\n  \"muted\": true,\n  \"announce\": {\n    \"text\": \"You're joining a billing call. You're muted.\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.pinnacle.sh/conferences/id/participants")
  .header("PINNACLE-API-KEY", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{\n  \"to\": \"+14155551234\",\n  \"from\": \"+14155559876\",\n  \"label\": \"supervisor\",\n  \"muted\": true,\n  \"announce\": {\n    \"text\": \"You're joining a billing call. You're muted.\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.pinnacle.sh/conferences/id/participants', [
  'body' => '{
  "to": "+14155551234",
  "from": "+14155559876",
  "label": "supervisor",
  "muted": true,
  "announce": {
    "text": "You\'re joining a billing call. You\'re muted."
  }
}',
  'headers' => [
    'Content-Type' => 'application/json',
    'PINNACLE-API-KEY' => '<apiKey>',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.pinnacle.sh/conferences/id/participants");
var request = new RestRequest(Method.POST);
request.AddHeader("PINNACLE-API-KEY", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"to\": \"+14155551234\",\n  \"from\": \"+14155559876\",\n  \"label\": \"supervisor\",\n  \"muted\": true,\n  \"announce\": {\n    \"text\": \"You're joining a billing call. You're muted.\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "PINNACLE-API-KEY": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [
  "to": "+14155551234",
  "from": "+14155559876",
  "label": "supervisor",
  "muted": true,
  "announce": ["text": "You're joining a billing call. You're muted."]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.pinnacle.sh/conferences/id/participants")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```