Practice

Set third-party identifier

Resolves the location from the X-Vendor-Request-Key header (slot); no location_id in the path.

This endpoint creates a third-party identifier for a specific location and individual. It is used to associate an external identifier with an individual in the system.

Parameters

location_id (required): The ID of the location where the third-party identifier is to be created.
individual_id & individual_type are not required for setting the practice’s third party identifier known as external id.
individual_id & individual_type are required for setting the employee’s third party identifier known as external id.
individual_id (optional): The ID of the individual for whom the third-party identifier is being created.
individual_type (optional): The type of individual (e.g., Employee).

Request Body

The request body must be in JSON format and should include the following:

third_party_identifier (object): Contains the external identifier.
- external_id (string): The external ID to be associated with the individual.

The response will contain a JSON object confirming the creation of the third-party identifier, including any relevant details.

POST

third_party_identifiers

Set third-party identifier

curl --request POST \
  --url https://api.teamcaredental.com/api/v2/vendors/third_party_identifiers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Vendor-Request-Key: <api-key>' \
  --data '
{
  "third_party_identifier": {
    "external_id": ""
  }
}
'

import requests

url = "https://api.teamcaredental.com/api/v2/vendors/third_party_identifiers"

payload = { "third_party_identifier": { "external_id": "" } }
headers = {
    "Authorization": "Bearer <token>",
    "X-Vendor-Request-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Vendor-Request-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({third_party_identifier: {external_id: ''}})
};

fetch('https://api.teamcaredental.com/api/v2/vendors/third_party_identifiers', 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.teamcaredental.com/api/v2/vendors/third_party_identifiers",
  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([
    'third_party_identifier' => [
        'external_id' => ''
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Vendor-Request-Key: <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.teamcaredental.com/api/v2/vendors/third_party_identifiers"

	payload := strings.NewReader("{\n  \"third_party_identifier\": {\n    \"external_id\": \"\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Vendor-Request-Key", "<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.teamcaredental.com/api/v2/vendors/third_party_identifiers")
  .header("Authorization", "Bearer <token>")
  .header("X-Vendor-Request-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"third_party_identifier\": {\n    \"external_id\": \"\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teamcaredental.com/api/v2/vendors/third_party_identifiers")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Vendor-Request-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"third_party_identifier\": {\n    \"external_id\": \"\"\n  }\n}"

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

{
  "data": {
    "id": "string",
    "type": "string",
    "attributes": {
      "external_id": "string"
    }
  }
}

{
  "errors": "not authorized"
}

{
  "errors": "access Denied"
}

{
  "errors": "resource not found"
}

{
  "errors": "..."
}

Authorizations

Authorization

string

header

required

JWT returned by POST /auth/token. Valid for six hours.

X-Vendor-Request-Key

string

header

required

Request key returned by POST /locations/{location_id}/slots. Identifies the practice for a data request; valid for 6 hours (the access token's lifetime) and subject to the firm's concurrent-slot quota.

Query Parameters

individual_id

integer

The ID of the individual for whom the third-party identifier is being created.

Example:

158821

individual_type

string

The type of individual (e.g., Employee).

Example:

"Employee"

Body

application/json

third_party_identifier

object

Contains the external identifier.

Show child attributes

Response

Successful response

data

object

Show child attributes

Set third-party identifier

curl --request POST \
  --url https://api.teamcaredental.com/api/v2/vendors/third_party_identifiers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --header 'X-Vendor-Request-Key: <api-key>' \
  --data '
{
  "third_party_identifier": {
    "external_id": ""
  }
}
'

import requests

url = "https://api.teamcaredental.com/api/v2/vendors/third_party_identifiers"

payload = { "third_party_identifier": { "external_id": "" } }
headers = {
    "Authorization": "Bearer <token>",
    "X-Vendor-Request-Key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {
    Authorization: 'Bearer <token>',
    'X-Vendor-Request-Key': '<api-key>',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({third_party_identifier: {external_id: ''}})
};

fetch('https://api.teamcaredental.com/api/v2/vendors/third_party_identifiers', 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.teamcaredental.com/api/v2/vendors/third_party_identifiers",
  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([
    'third_party_identifier' => [
        'external_id' => ''
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json",
    "X-Vendor-Request-Key: <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.teamcaredental.com/api/v2/vendors/third_party_identifiers"

	payload := strings.NewReader("{\n  \"third_party_identifier\": {\n    \"external_id\": \"\"\n  }\n}")

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

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("X-Vendor-Request-Key", "<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.teamcaredental.com/api/v2/vendors/third_party_identifiers")
  .header("Authorization", "Bearer <token>")
  .header("X-Vendor-Request-Key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"third_party_identifier\": {\n    \"external_id\": \"\"\n  }\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.teamcaredental.com/api/v2/vendors/third_party_identifiers")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["X-Vendor-Request-Key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"third_party_identifier\": {\n    \"external_id\": \"\"\n  }\n}"

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

{
  "data": {
    "id": "string",
    "type": "string",
    "attributes": {
      "external_id": "string"
    }
  }
}

{
  "errors": "not authorized"
}

{
  "errors": "access Denied"
}

{
  "errors": "resource not found"
}

{
  "errors": "..."
}

Getting Started

Core APIs

AI Agent API

Foundations

Set third-party identifier

Parameters

Request Body

Authorizations

Query Parameters

Body

Response