Skip to main content
PATCH
/
phoneConnections
/
{id}
Update phone connection
curl --request PATCH \
  --url https://api.galtea.ai/phoneConnections/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "productId": "prod_123",
  "name": "Support line",
  "phoneNumber": "+14155552671",
  "id": "phoneConnection_123",
  "userId": "user_123",
  "voice": "jack",
  "languageCode": "en-US",
  "agentSpeaksFirst": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}
'
{
  "productId": "prod_123",
  "name": "Support line",
  "phoneNumber": "+14155552671",
  "id": "phoneConnection_123",
  "userId": "user_123",
  "voice": "jack",
  "languageCode": "en-US",
  "agentSpeaksFirst": false,
  "createdAt": "2023-11-07T05:31:56Z",
  "deletedAt": "2023-11-07T05:31:56Z"
}

Authorizations

​
Authorization
string
header
required

API key authorization. Pass your API key in the Authorization header as a Bearer token. Both new (gsk_*) and legacy (gsk-) API keys are accepted, e.g. Authorization: Bearer gsk_... or Authorization: Bearer gsk-....

Path Parameters

​
id
string
required

PhoneConnection ID

Body

application/json
​
productId
string
required
Example:

"prod_123"

​
name
string
required
Example:

"Support line"

​
phoneNumber
string
required

The phone number Galtea dials, in E.164 format.

Example:

"+14155552671"

​
id
string
Example:

"phoneConnection_123"

​
userId
string | null
Example:

"user_123"

​
voice
string | null

TTS voice the simulated caller speaks with (Speechmatics, English-only). One of sarah (en-GB female), theo (en-GB male), megan (en-US female), jack (en-US male) — fetch the current set from GET /phoneConnections/voices. Leave empty/null to use the default voice (sarah). An unsupported value is rejected with 400.

Example:

"jack"

​
languageCode
string | null

Optional language code for the telephony agent.

Example:

"en-US"

​
agentSpeaksFirst
boolean
default:false

Whether the voice agent opens the conversation once the call connects. false (default) means the simulated caller speaks first; true suits interviewer-style agents that greet first.

Example:

false

​
createdAt
string<date-time>
​
deletedAt
string<date-time> | null

Response

Phone connection updated successfully

​
productId
string
required
Example:

"prod_123"

​
name
string
required
Example:

"Support line"

​
phoneNumber
string
required

The phone number Galtea dials, in E.164 format.

Example:

"+14155552671"

​
id
string
Example:

"phoneConnection_123"

​
userId
string | null
Example:

"user_123"

​
voice
string | null

TTS voice the simulated caller speaks with (Speechmatics, English-only). One of sarah (en-GB female), theo (en-GB male), megan (en-US female), jack (en-US male) — fetch the current set from GET /phoneConnections/voices. Leave empty/null to use the default voice (sarah). An unsupported value is rejected with 400.

Example:

"jack"

​
languageCode
string | null

Optional language code for the telephony agent.

Example:

"en-US"

​
agentSpeaksFirst
boolean
default:false

Whether the voice agent opens the conversation once the call connects. false (default) means the simulated caller speaks first; true suits interviewer-style agents that greet first.

Example:

false

​
createdAt
string<date-time>
​
deletedAt
string<date-time> | null