Create a branch

Create a branch

curl --request POST \
  --url https://scribe-api.telepatia.ai/v1/institutional/branches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "Av. 7 #12-34",
  "main": false,
  "name": "Sede Norte",
  "type": "single"
}
'

import requests

url = "https://scribe-api.telepatia.ai/v1/institutional/branches"

payload = {
    "address": "Av. 7 #12-34",
    "main": False,
    "name": "Sede Norte",
    "type": "single"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({address: 'Av. 7 #12-34', main: false, name: 'Sede Norte', type: 'single'})
};

fetch('https://scribe-api.telepatia.ai/v1/institutional/branches', 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://scribe-api.telepatia.ai/v1/institutional/branches",
  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([
    'address' => 'Av. 7 #12-34',
    'main' => false,
    'name' => 'Sede Norte',
    'type' => 'single'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://scribe-api.telepatia.ai/v1/institutional/branches"

	payload := strings.NewReader("{\n  \"address\": \"Av. 7 #12-34\",\n  \"main\": false,\n  \"name\": \"Sede Norte\",\n  \"type\": \"single\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://scribe-api.telepatia.ai/v1/institutional/branches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": \"Av. 7 #12-34\",\n  \"main\": false,\n  \"name\": \"Sede Norte\",\n  \"type\": \"single\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://scribe-api.telepatia.ai/v1/institutional/branches")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": \"Av. 7 #12-34\",\n  \"main\": false,\n  \"name\": \"Sede Norte\",\n  \"type\": \"single\"\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "type": "single",
  "visible": true,
  "main": true,
  "order": 123,
  "description": "<string>",
  "address": "<string>",
  "IPS": [
    "<string>"
  ],
  "coordinates": {
    "latitude": 0,
    "longitude": 0
  },
  "expectedConsultations": 123,
  "branchManagerAccountIds": [
    "<string>"
  ],
  "cdssConfigurationId": "<string>",
  "auditConfigurationId": "<string>",
  "sessionStartLabel": "<string>"
}

POST

institutional

branches

Create a branch

curl --request POST \
  --url https://scribe-api.telepatia.ai/v1/institutional/branches \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "address": "Av. 7 #12-34",
  "main": false,
  "name": "Sede Norte",
  "type": "single"
}
'

import requests

url = "https://scribe-api.telepatia.ai/v1/institutional/branches"

payload = {
    "address": "Av. 7 #12-34",
    "main": False,
    "name": "Sede Norte",
    "type": "single"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({address: 'Av. 7 #12-34', main: false, name: 'Sede Norte', type: 'single'})
};

fetch('https://scribe-api.telepatia.ai/v1/institutional/branches', 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://scribe-api.telepatia.ai/v1/institutional/branches",
  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([
    'address' => 'Av. 7 #12-34',
    'main' => false,
    'name' => 'Sede Norte',
    'type' => 'single'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

$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://scribe-api.telepatia.ai/v1/institutional/branches"

	payload := strings.NewReader("{\n  \"address\": \"Av. 7 #12-34\",\n  \"main\": false,\n  \"name\": \"Sede Norte\",\n  \"type\": \"single\"\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	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://scribe-api.telepatia.ai/v1/institutional/branches")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"address\": \"Av. 7 #12-34\",\n  \"main\": false,\n  \"name\": \"Sede Norte\",\n  \"type\": \"single\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://scribe-api.telepatia.ai/v1/institutional/branches")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"address\": \"Av. 7 #12-34\",\n  \"main\": false,\n  \"name\": \"Sede Norte\",\n  \"type\": \"single\"\n}"

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

{
  "id": "<string>",
  "name": "<string>",
  "type": "single",
  "visible": true,
  "main": true,
  "order": 123,
  "description": "<string>",
  "address": "<string>",
  "IPS": [
    "<string>"
  ],
  "coordinates": {
    "latitude": 0,
    "longitude": 0
  },
  "expectedConsultations": 123,
  "branchManagerAccountIds": [
    "<string>"
  ],
  "cdssConfigurationId": "<string>",
  "auditConfigurationId": "<string>",
  "sessionStartLabel": "<string>"
}

Authorizations

Authorization

string

header

required

API key passed as a Bearer token

Body

application/json

Request body for creating an institution branch.

Mirrors datalayer's branch input. Only name is required; omitted fields fall back to datalayer defaults (visible=true, type=single, main=false, order=0, IPS=[]). The branch id is generated server-side.

name

string

required

Maximum string length: 255

Example:

"Sede Norte"

type

enum<string> | null

Branch type — single site or multi-site.

Available options:

single,

multi

Example:

"single"

visible

boolean | null

Example:

true

main

boolean | null

Example:

false

order

integer | null

Required range: x >= 0

Example:

0

description

string | null

Maximum string length: 1000

address

string | null

Maximum string length: 500

Example:

"Av. 7 #12-34"

IPS

string[] | null

coordinates

Coordinates · object | null

Geographic coordinates of a branch.

Show child attributes

expectedConsultations

integer | null

Required range: x >= 0

branchManagerAccountIds

string[] | null

cdssConfigurationId

string | null

auditConfigurationId

string | null

sessionStartLabel

enum<string> | null

Wording the scribe clients use on the start-session button.

Available options:

consultation,

reading

Response

Successful Response

Response body after creating an institution branch.

string

required

Server-generated branch id.

name

string

required

Example:

"Sede Norte"

type

string | null

Example:

"single"

visible

boolean | null

main

boolean | null

order

integer | null

description

string | null

address

string | null

IPS

string[] | null

coordinates

Coordinates · object | null

Geographic coordinates of a branch.

Show child attributes

expectedConsultations

integer | null

branchManagerAccountIds

string[] | null

cdssConfigurationId

string | null

auditConfigurationId

string | null

sessionStartLabel

string | null

Authentication

Accounts

Branches

Scribe Sessions

Clinical Decision Support

Smart Templates

Session Templates

Webhooks

Patients

Authorizations

Body

Response