Create contact
curl --request POST \
--url https://api.piriod.com/contacts/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-simple-workspace: <x-simple-workspace>' \
--data '
{
"name": "<string>",
"email": "jsmith@example.com",
"customer": "<string>",
"orgunit": "<string>",
"phone": "<string>",
"invoicing": true,
"collections": true
}
'import requests
url = "https://api.piriod.com/contacts/"
payload = {
"name": "<string>",
"email": "jsmith@example.com",
"customer": "<string>",
"orgunit": "<string>",
"phone": "<string>",
"invoicing": True,
"collections": True
}
headers = {
"x-simple-workspace": "<x-simple-workspace>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-simple-workspace': '<x-simple-workspace>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
email: 'jsmith@example.com',
customer: '<string>',
orgunit: '<string>',
phone: '<string>',
invoicing: true,
collections: true
})
};
fetch('https://api.piriod.com/contacts/', 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.piriod.com/contacts/",
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>',
'email' => 'jsmith@example.com',
'customer' => '<string>',
'orgunit' => '<string>',
'phone' => '<string>',
'invoicing' => true,
'collections' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"x-simple-workspace: <x-simple-workspace>"
],
]);
$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.piriod.com/contacts/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"customer\": \"<string>\",\n \"orgunit\": \"<string>\",\n \"phone\": \"<string>\",\n \"invoicing\": true,\n \"collections\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-simple-workspace", "<x-simple-workspace>")
req.Header.Add("Authorization", "<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.piriod.com/contacts/")
.header("x-simple-workspace", "<x-simple-workspace>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"customer\": \"<string>\",\n \"orgunit\": \"<string>\",\n \"phone\": \"<string>\",\n \"invoicing\": true,\n \"collections\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.piriod.com/contacts/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-simple-workspace"] = '<x-simple-workspace>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"customer\": \"<string>\",\n \"orgunit\": \"<string>\",\n \"phone\": \"<string>\",\n \"invoicing\": true,\n \"collections\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"email": "jsmith@example.com",
"id": "con_01H8XYZ123ABC",
"customer": "<string>",
"orgunit": "<string>",
"phone": "<string>",
"invoicing": true,
"collections": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}{
"name": [
"This field is required."
],
"non_field_errors": [
"x-simple-workspace header is required."
]
}Contacts
Create contact
POST
/
contacts
/
Create contact
curl --request POST \
--url https://api.piriod.com/contacts/ \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--header 'x-simple-workspace: <x-simple-workspace>' \
--data '
{
"name": "<string>",
"email": "jsmith@example.com",
"customer": "<string>",
"orgunit": "<string>",
"phone": "<string>",
"invoicing": true,
"collections": true
}
'import requests
url = "https://api.piriod.com/contacts/"
payload = {
"name": "<string>",
"email": "jsmith@example.com",
"customer": "<string>",
"orgunit": "<string>",
"phone": "<string>",
"invoicing": True,
"collections": True
}
headers = {
"x-simple-workspace": "<x-simple-workspace>",
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-simple-workspace': '<x-simple-workspace>',
Authorization: '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
name: '<string>',
email: 'jsmith@example.com',
customer: '<string>',
orgunit: '<string>',
phone: '<string>',
invoicing: true,
collections: true
})
};
fetch('https://api.piriod.com/contacts/', 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.piriod.com/contacts/",
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>',
'email' => 'jsmith@example.com',
'customer' => '<string>',
'orgunit' => '<string>',
'phone' => '<string>',
'invoicing' => true,
'collections' => true
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json",
"x-simple-workspace: <x-simple-workspace>"
],
]);
$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.piriod.com/contacts/"
payload := strings.NewReader("{\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"customer\": \"<string>\",\n \"orgunit\": \"<string>\",\n \"phone\": \"<string>\",\n \"invoicing\": true,\n \"collections\": true\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-simple-workspace", "<x-simple-workspace>")
req.Header.Add("Authorization", "<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.piriod.com/contacts/")
.header("x-simple-workspace", "<x-simple-workspace>")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"customer\": \"<string>\",\n \"orgunit\": \"<string>\",\n \"phone\": \"<string>\",\n \"invoicing\": true,\n \"collections\": true\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.piriod.com/contacts/")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-simple-workspace"] = '<x-simple-workspace>'
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": \"<string>\",\n \"email\": \"jsmith@example.com\",\n \"customer\": \"<string>\",\n \"orgunit\": \"<string>\",\n \"phone\": \"<string>\",\n \"invoicing\": true,\n \"collections\": true\n}"
response = http.request(request)
puts response.read_body{
"name": "<string>",
"email": "jsmith@example.com",
"id": "con_01H8XYZ123ABC",
"customer": "<string>",
"orgunit": "<string>",
"phone": "<string>",
"invoicing": true,
"collections": true,
"created": "2023-11-07T05:31:56Z",
"updated": "2023-11-07T05:31:56Z"
}{
"name": [
"This field is required."
],
"non_field_errors": [
"x-simple-workspace header is required."
]
}Authorizations
Use header Authorization: Token <api_token>.
API tokens are obtained from the Piriod dashboard.
Headers
Workspace (account) identifier. Required for every request.
Whether to operate against test-mode data. Defaults to false.
Body
application/json
Response
Contact created.
Maximum string length:
64Example:
"con_01H8XYZ123ABC"
Customer ID this contact belongs to.
Organisation unit ID. Optional sub-grouping inside a customer.
Maximum string length:
12Whether this contact receives invoice emails.
Whether this contact receives collection reminders.
⌘I
