Add Action to Telephone Encounter

curl --request POST \
  --url https://api.usecobalt.com/v1/telephone-encounters/actions \
  --header 'Content-Type: application/json' \
  --header 'access_token: <api-key>' \
  --header 'client_id: <api-key>' \
  --header 'client_secret: <api-key>' \
  --data '
{
  "appointment_id": "<string>",
  "text": "<string>"
}
'

import requests

url = "https://api.usecobalt.com/v1/telephone-encounters/actions"

payload = {
    "appointment_id": "<string>",
    "text": "<string>"
}
headers = {
    "client_id": "<api-key>",
    "client_secret": "<api-key>",
    "access_token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    client_id: '<api-key>',
    client_secret: '<api-key>',
    access_token: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({appointment_id: '<string>', text: '<string>'})
};

fetch('https://api.usecobalt.com/v1/telephone-encounters/actions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usecobalt.com/v1/telephone-encounters/actions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'appointment_id' => '<string>',
    'text' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "access_token: <api-key>",
    "client_id: <api-key>",
    "client_secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.usecobalt.com/v1/telephone-encounters/actions"

	payload := strings.NewReader("{\n  \"appointment_id\": \"<string>\",\n  \"text\": \"<string>\"\n}")

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

	req.Header.Add("client_id", "<api-key>")
	req.Header.Add("client_secret", "<api-key>")
	req.Header.Add("access_token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.usecobalt.com/v1/telephone-encounters/actions")
  .header("client_id", "<api-key>")
  .header("client_secret", "<api-key>")
  .header("access_token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"appointment_id\": \"<string>\",\n  \"text\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usecobalt.com/v1/telephone-encounters/actions")

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

request = Net::HTTP::Post.new(url)
request["client_id"] = '<api-key>'
request["client_secret"] = '<api-key>'
request["access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"appointment_id\": \"<string>\",\n  \"text\": \"<string>\"\n}"

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

{
  "success": true,
  "message": "Action processing. A webhook event will be sent upon completion.",
  "action_id": "<string>",
  "job_id": 123
}

{
  "success": true,
  "message": "Missing required parameters: appointment_id, text."
}

{
  "success": true,
  "message": "Error creating action.",
  "action_id": "<string>"
}

POST

telephone-encounters

actions

Add Action to Telephone Encounter

curl --request POST \
  --url https://api.usecobalt.com/v1/telephone-encounters/actions \
  --header 'Content-Type: application/json' \
  --header 'access_token: <api-key>' \
  --header 'client_id: <api-key>' \
  --header 'client_secret: <api-key>' \
  --data '
{
  "appointment_id": "<string>",
  "text": "<string>"
}
'

import requests

url = "https://api.usecobalt.com/v1/telephone-encounters/actions"

payload = {
    "appointment_id": "<string>",
    "text": "<string>"
}
headers = {
    "client_id": "<api-key>",
    "client_secret": "<api-key>",
    "access_token": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    client_id: '<api-key>',
    client_secret: '<api-key>',
    access_token: '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({appointment_id: '<string>', text: '<string>'})
};

fetch('https://api.usecobalt.com/v1/telephone-encounters/actions', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.usecobalt.com/v1/telephone-encounters/actions",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'appointment_id' => '<string>',
    'text' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "access_token: <api-key>",
    "client_id: <api-key>",
    "client_secret: <api-key>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

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

func main() {

	url := "https://api.usecobalt.com/v1/telephone-encounters/actions"

	payload := strings.NewReader("{\n  \"appointment_id\": \"<string>\",\n  \"text\": \"<string>\"\n}")

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

	req.Header.Add("client_id", "<api-key>")
	req.Header.Add("client_secret", "<api-key>")
	req.Header.Add("access_token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.usecobalt.com/v1/telephone-encounters/actions")
  .header("client_id", "<api-key>")
  .header("client_secret", "<api-key>")
  .header("access_token", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"appointment_id\": \"<string>\",\n  \"text\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.usecobalt.com/v1/telephone-encounters/actions")

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

request = Net::HTTP::Post.new(url)
request["client_id"] = '<api-key>'
request["client_secret"] = '<api-key>'
request["access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"appointment_id\": \"<string>\",\n  \"text\": \"<string>\"\n}"

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

{
  "success": true,
  "message": "Action processing. A webhook event will be sent upon completion.",
  "action_id": "<string>",
  "job_id": 123
}

{
  "success": true,
  "message": "Missing required parameters: appointment_id, text."
}

{
  "success": true,
  "message": "Error creating action.",
  "action_id": "<string>"
}

Request Parameters

Required Fields

appointment_id (string, required): The ID of the telephone encounter
text (string, required): The action text/note to add to the telephone encounter log

How It Works

When you add an action to a telephone encounter:

Formatting: The action is automatically formatted with the staff member’s name, timestamp, and timezone
Appending: The formatted action is appended to the existing action log in the telephone encounter
Timestamping: Each action includes the exact date, time, and timezone when it was added

Example Request

curl -X POST https://api.usecobalt.com/v1/telephone-encounters/actions \
-H 'Content-Type: application/json' \
-H 'client_id: ci_live_198908HJDKJSH98789OHKJL' \
-H 'client_secret: cs_live_9827hofdsklOYYHJLJh' \
-H 'access_token: 493JKLHIU98789hLKH9HHJH' \
-d '{
    "appointment_id": "3fa85f6457174562b3fc2c963f66afa6",
    "text": "Patient called for prescription refill"
}'

Example Response

{
  "success": true,
  "message": "Action processing. A webhook event will be sent upon completion.",
  "action_id": "a7b8c9d0e1f2g3h4i5j6k7l8m9n0o1p2",
  "job_id": 12345
}

Response Fields

success (boolean): Indicates if the request was accepted for processing
message (string): Confirmation message
action_id (string): Unique identifier for the action record (32-character hex string)
job_id (integer): Reference to the job that will process this action

Webhook Events

You’ll receive a webhook when the action is processed:

Success Event

{
  "id": "evt_abc123",
  "object": "event",
  "type": "telephone_encounter_action.created",
  "created": "2026-01-21T20:15:30.000Z",
  "job_id": "12345",
  "access_token_reference_id": "user_123",
  "data": {
    "action_id": "a7b8c9d0e1f2g3h4i5j6k7l8m9n0o1p2",
    "emr_appointment_id": "3784895",
    "text": "Patient called for prescription refill"
  }
}

Authorizations

client_id

string

header

required

client_secret

string

header

required

access_token

string

header

required

Body

application/json

appointment_id

string

required

The ID of the telephone encounter

text

string

required

The action text/note to add to the telephone encounter log

is_high_priority

enum<string>

Whether this action should be marked as high priority (optional). Must be "true" or "false"

Available options:

true,

false

Response

Action queued successfully

success

boolean

message

string

Example:

"Action processing. A webhook event will be sent upon completion."

action_id

string

Unique identifier for the action record (32-character hex string)

job_id

integer

Job execution identifier for tracking the async operation

Create Telephone Encounter Get Visit Statuses

​Request Parameters

​Required Fields

​How It Works

​Example Request

​Example Response

​Response Fields

​Webhook Events

​Success Event

Authorizations

Body

Response

Request Parameters

Required Fields

How It Works

Example Request

Example Response

Response Fields

Webhook Events

Success Event