curl --request POST \
--url https://api.alpharun.com/api/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"phone_number": "<string>",
"ext_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
]
}
'import requests
url = "https://api.alpharun.com/api/v1/contacts"
payload = {
"email": "[email protected]",
"phone_number": "<string>",
"ext_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
]
}
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({
email: '[email protected]',
phone_number: '<string>',
ext_id: '<string>',
first_name: '<string>',
last_name: '<string>',
custom_fields: [{key: '<string>', value: '<string>'}]
})
};
fetch('https://api.alpharun.com/api/v1/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.alpharun.com/api/v1/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([
'email' => '[email protected]',
'phone_number' => '<string>',
'ext_id' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'custom_fields' => [
[
'key' => '<string>',
'value' => '<string>'
]
]
]),
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://api.alpharun.com/api/v1/contacts"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"phone_number\": \"<string>\",\n \"ext_id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\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://api.alpharun.com/api/v1/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"phone_number\": \"<string>\",\n \"ext_id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpharun.com/api/v1/contacts")
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 \"email\": \"[email protected]\",\n \"phone_number\": \"<string>\",\n \"ext_id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"email": "[email protected]",
"phone_number": "<string>",
"ext_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"custom_fields": [
{
"key": "<string>",
"value": "<string>",
"type": "<string>",
"display_name": "<string>"
}
]
}{
"error": 123,
"message": "<string>"
}Create Contact
Custom fields must be created in the Alpharun dashboard before you can add them to the contact.
curl --request POST \
--url https://api.alpharun.com/api/v1/contacts \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"email": "[email protected]",
"phone_number": "<string>",
"ext_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
]
}
'import requests
url = "https://api.alpharun.com/api/v1/contacts"
payload = {
"email": "[email protected]",
"phone_number": "<string>",
"ext_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"custom_fields": [
{
"key": "<string>",
"value": "<string>"
}
]
}
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({
email: '[email protected]',
phone_number: '<string>',
ext_id: '<string>',
first_name: '<string>',
last_name: '<string>',
custom_fields: [{key: '<string>', value: '<string>'}]
})
};
fetch('https://api.alpharun.com/api/v1/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.alpharun.com/api/v1/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([
'email' => '[email protected]',
'phone_number' => '<string>',
'ext_id' => '<string>',
'first_name' => '<string>',
'last_name' => '<string>',
'custom_fields' => [
[
'key' => '<string>',
'value' => '<string>'
]
]
]),
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://api.alpharun.com/api/v1/contacts"
payload := strings.NewReader("{\n \"email\": \"[email protected]\",\n \"phone_number\": \"<string>\",\n \"ext_id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\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://api.alpharun.com/api/v1/contacts")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"email\": \"[email protected]\",\n \"phone_number\": \"<string>\",\n \"ext_id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.alpharun.com/api/v1/contacts")
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 \"email\": \"[email protected]\",\n \"phone_number\": \"<string>\",\n \"ext_id\": \"<string>\",\n \"first_name\": \"<string>\",\n \"last_name\": \"<string>\",\n \"custom_fields\": [\n {\n \"key\": \"<string>\",\n \"value\": \"<string>\"\n }\n ]\n}"
response = http.request(request)
puts response.read_body{
"id": "<string>",
"email": "[email protected]",
"phone_number": "<string>",
"ext_id": "<string>",
"first_name": "<string>",
"last_name": "<string>",
"custom_fields": [
{
"key": "<string>",
"value": "<string>",
"type": "<string>",
"display_name": "<string>"
}
]
}{
"error": 123,
"message": "<string>"
}Authorizations
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Body
At least one of email, phone number and ext id must be not null on the contact. Contacts are unique per email, phone number, or ext_id. No two contacts can have the same email, phone number, or ext_id.
- Option 1
- Option 2
- Option 3
Email address of the contact
Phone number of the contact
Ext id of the contact
First name of the contact
Last name of the contact
Custom fields to populate on the contact
Show child attributes
Show child attributes
Response
Contact created successfully
ID of the contact
Email address of the contact
Phone number of the contact
Ext id of the contact
First name of the contact
Last name of the contact
Custom fields of the contact
Show child attributes
Show child attributes