Create healthcare service
curl --request POST \
--url https://api.clinikapi.com/v1/healthcare-services \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"active": true,
"providedById": "<string>",
"category": [
"<string>"
],
"type": [
"<string>"
],
"specialty": [
"<string>"
],
"locationNames": [
"<string>"
],
"comment": "<string>",
"phone": "<string>",
"email": "<string>",
"appointmentRequired": true,
"availableTime": [
{
"daysOfWeek": [],
"allDay": true,
"availableStartTime": "<string>",
"availableEndTime": "<string>"
}
],
"notAvailable": [
{
"description": "<string>",
"during": {
"start": "<string>",
"end": "<string>"
}
}
],
"availabilityExceptions": "<string>",
"program": [
"<string>"
],
"referralMethod": [
"<string>"
],
"communication": [
"<string>"
]
}
'import requests
url = "https://api.clinikapi.com/v1/healthcare-services"
payload = {
"name": "<string>",
"active": True,
"providedById": "<string>",
"category": ["<string>"],
"type": ["<string>"],
"specialty": ["<string>"],
"locationNames": ["<string>"],
"comment": "<string>",
"phone": "<string>",
"email": "<string>",
"appointmentRequired": True,
"availableTime": [
{
"daysOfWeek": [],
"allDay": True,
"availableStartTime": "<string>",
"availableEndTime": "<string>"
}
],
"notAvailable": [
{
"description": "<string>",
"during": {
"start": "<string>",
"end": "<string>"
}
}
],
"availabilityExceptions": "<string>",
"program": ["<string>"],
"referralMethod": ["<string>"],
"communication": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
active: true,
providedById: '<string>',
category: ['<string>'],
type: ['<string>'],
specialty: ['<string>'],
locationNames: ['<string>'],
comment: '<string>',
phone: '<string>',
email: '<string>',
appointmentRequired: true,
availableTime: [
{
daysOfWeek: [],
allDay: true,
availableStartTime: '<string>',
availableEndTime: '<string>'
}
],
notAvailable: [{description: '<string>', during: {start: '<string>', end: '<string>'}}],
availabilityExceptions: '<string>',
program: ['<string>'],
referralMethod: ['<string>'],
communication: ['<string>']
})
};
fetch('https://api.clinikapi.com/v1/healthcare-services', 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.clinikapi.com/v1/healthcare-services",
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([
'name' => '<string>',
'active' => true,
'providedById' => '<string>',
'category' => [
'<string>'
],
'type' => [
'<string>'
],
'specialty' => [
'<string>'
],
'locationNames' => [
'<string>'
],
'comment' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'appointmentRequired' => true,
'availableTime' => [
[
'daysOfWeek' => [
],
'allDay' => true,
'availableStartTime' => '<string>',
'availableEndTime' => '<string>'
]
],
'notAvailable' => [
[
'description' => '<string>',
'during' => [
'start' => '<string>',
'end' => '<string>'
]
]
],
'availabilityExceptions' => '<string>',
'program' => [
'<string>'
],
'referralMethod' => [
'<string>'
],
'communication' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-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.clinikapi.com/v1/healthcare-services"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"active\": true,\n \"providedById\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"type\": [\n \"<string>\"\n ],\n \"specialty\": [\n \"<string>\"\n ],\n \"locationNames\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"appointmentRequired\": true,\n \"availableTime\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n }\n ],\n \"notAvailable\": [\n {\n \"description\": \"<string>\",\n \"during\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"availabilityExceptions\": \"<string>\",\n \"program\": [\n \"<string>\"\n ],\n \"referralMethod\": [\n \"<string>\"\n ],\n \"communication\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-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.clinikapi.com/v1/healthcare-services")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"active\": true,\n \"providedById\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"type\": [\n \"<string>\"\n ],\n \"specialty\": [\n \"<string>\"\n ],\n \"locationNames\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"appointmentRequired\": true,\n \"availableTime\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n }\n ],\n \"notAvailable\": [\n {\n \"description\": \"<string>\",\n \"during\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"availabilityExceptions\": \"<string>\",\n \"program\": [\n \"<string>\"\n ],\n \"referralMethod\": [\n \"<string>\"\n ],\n \"communication\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/healthcare-services")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"active\": true,\n \"providedById\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"type\": [\n \"<string>\"\n ],\n \"specialty\": [\n \"<string>\"\n ],\n \"locationNames\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"appointmentRequired\": true,\n \"availableTime\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n }\n ],\n \"notAvailable\": [\n {\n \"description\": \"<string>\",\n \"during\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"availabilityExceptions\": \"<string>\",\n \"program\": [\n \"<string>\"\n ],\n \"referralMethod\": [\n \"<string>\"\n ],\n \"communication\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyHealthcare Services
Create Healthcare Service
POST
/
v1
/
healthcare-services
Create healthcare service
curl --request POST \
--url https://api.clinikapi.com/v1/healthcare-services \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"name": "<string>",
"active": true,
"providedById": "<string>",
"category": [
"<string>"
],
"type": [
"<string>"
],
"specialty": [
"<string>"
],
"locationNames": [
"<string>"
],
"comment": "<string>",
"phone": "<string>",
"email": "<string>",
"appointmentRequired": true,
"availableTime": [
{
"daysOfWeek": [],
"allDay": true,
"availableStartTime": "<string>",
"availableEndTime": "<string>"
}
],
"notAvailable": [
{
"description": "<string>",
"during": {
"start": "<string>",
"end": "<string>"
}
}
],
"availabilityExceptions": "<string>",
"program": [
"<string>"
],
"referralMethod": [
"<string>"
],
"communication": [
"<string>"
]
}
'import requests
url = "https://api.clinikapi.com/v1/healthcare-services"
payload = {
"name": "<string>",
"active": True,
"providedById": "<string>",
"category": ["<string>"],
"type": ["<string>"],
"specialty": ["<string>"],
"locationNames": ["<string>"],
"comment": "<string>",
"phone": "<string>",
"email": "<string>",
"appointmentRequired": True,
"availableTime": [
{
"daysOfWeek": [],
"allDay": True,
"availableStartTime": "<string>",
"availableEndTime": "<string>"
}
],
"notAvailable": [
{
"description": "<string>",
"during": {
"start": "<string>",
"end": "<string>"
}
}
],
"availabilityExceptions": "<string>",
"program": ["<string>"],
"referralMethod": ["<string>"],
"communication": ["<string>"]
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: '<string>',
active: true,
providedById: '<string>',
category: ['<string>'],
type: ['<string>'],
specialty: ['<string>'],
locationNames: ['<string>'],
comment: '<string>',
phone: '<string>',
email: '<string>',
appointmentRequired: true,
availableTime: [
{
daysOfWeek: [],
allDay: true,
availableStartTime: '<string>',
availableEndTime: '<string>'
}
],
notAvailable: [{description: '<string>', during: {start: '<string>', end: '<string>'}}],
availabilityExceptions: '<string>',
program: ['<string>'],
referralMethod: ['<string>'],
communication: ['<string>']
})
};
fetch('https://api.clinikapi.com/v1/healthcare-services', 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.clinikapi.com/v1/healthcare-services",
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([
'name' => '<string>',
'active' => true,
'providedById' => '<string>',
'category' => [
'<string>'
],
'type' => [
'<string>'
],
'specialty' => [
'<string>'
],
'locationNames' => [
'<string>'
],
'comment' => '<string>',
'phone' => '<string>',
'email' => '<string>',
'appointmentRequired' => true,
'availableTime' => [
[
'daysOfWeek' => [
],
'allDay' => true,
'availableStartTime' => '<string>',
'availableEndTime' => '<string>'
]
],
'notAvailable' => [
[
'description' => '<string>',
'during' => [
'start' => '<string>',
'end' => '<string>'
]
]
],
'availabilityExceptions' => '<string>',
'program' => [
'<string>'
],
'referralMethod' => [
'<string>'
],
'communication' => [
'<string>'
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-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.clinikapi.com/v1/healthcare-services"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"active\": true,\n \"providedById\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"type\": [\n \"<string>\"\n ],\n \"specialty\": [\n \"<string>\"\n ],\n \"locationNames\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"appointmentRequired\": true,\n \"availableTime\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n }\n ],\n \"notAvailable\": [\n {\n \"description\": \"<string>\",\n \"during\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"availabilityExceptions\": \"<string>\",\n \"program\": [\n \"<string>\"\n ],\n \"referralMethod\": [\n \"<string>\"\n ],\n \"communication\": [\n \"<string>\"\n ]\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-api-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.clinikapi.com/v1/healthcare-services")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"active\": true,\n \"providedById\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"type\": [\n \"<string>\"\n ],\n \"specialty\": [\n \"<string>\"\n ],\n \"locationNames\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"appointmentRequired\": true,\n \"availableTime\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n }\n ],\n \"notAvailable\": [\n {\n \"description\": \"<string>\",\n \"during\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"availabilityExceptions\": \"<string>\",\n \"program\": [\n \"<string>\"\n ],\n \"referralMethod\": [\n \"<string>\"\n ],\n \"communication\": [\n \"<string>\"\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.clinikapi.com/v1/healthcare-services")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"active\": true,\n \"providedById\": \"<string>\",\n \"category\": [\n \"<string>\"\n ],\n \"type\": [\n \"<string>\"\n ],\n \"specialty\": [\n \"<string>\"\n ],\n \"locationNames\": [\n \"<string>\"\n ],\n \"comment\": \"<string>\",\n \"phone\": \"<string>\",\n \"email\": \"<string>\",\n \"appointmentRequired\": true,\n \"availableTime\": [\n {\n \"daysOfWeek\": [],\n \"allDay\": true,\n \"availableStartTime\": \"<string>\",\n \"availableEndTime\": \"<string>\"\n }\n ],\n \"notAvailable\": [\n {\n \"description\": \"<string>\",\n \"during\": {\n \"start\": \"<string>\",\n \"end\": \"<string>\"\n }\n }\n ],\n \"availabilityExceptions\": \"<string>\",\n \"program\": [\n \"<string>\"\n ],\n \"referralMethod\": [\n \"<string>\"\n ],\n \"communication\": [\n \"<string>\"\n ]\n}"
response = http.request(request)
puts response.read_bodyAuthorizations
Your ClinikAPI secret key (clk_live_* or clk_test_*)
Body
application/json
Maximum string length:
500Organization that provides this service
Maximum string length:
2000Show child attributes
Show child attributes
Show child attributes
Show child attributes
Maximum string length:
1000Response
201
Healthcare service created
⌘I