Create a new contact

curl --request POST \
  --url https://eu.sequencehq.com/api/customers/{customer}/contacts \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Smith",
  "email": "john.smith@example.com",
  "billingPreference": "PRIMARY",
  "purposes": [
    "BILLING",
    "SHIPPING"
  ],
  "notificationSubscriptions": [
    "BILLING"
  ]
}
'

import requests

url = "https://eu.sequencehq.com/api/customers/{customer}/contacts"

payload = {
    "name": "John Smith",
    "email": "john.smith@example.com",
    "billingPreference": "PRIMARY",
    "purposes": ["BILLING", "SHIPPING"],
    "notificationSubscriptions": ["BILLING"]
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'John Smith',
    email: 'john.smith@example.com',
    billingPreference: 'PRIMARY',
    purposes: ['BILLING', 'SHIPPING'],
    notificationSubscriptions: ['BILLING']
  })
};

fetch('https://eu.sequencehq.com/api/customers/{customer}/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://eu.sequencehq.com/api/customers/{customer}/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' => 'John Smith',
    'email' => 'john.smith@example.com',
    'billingPreference' => 'PRIMARY',
    'purposes' => [
        'BILLING',
        'SHIPPING'
    ],
    'notificationSubscriptions' => [
        'BILLING'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "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://eu.sequencehq.com/api/customers/{customer}/contacts"

	payload := strings.NewReader("{\n  \"name\": \"John Smith\",\n  \"email\": \"john.smith@example.com\",\n  \"billingPreference\": \"PRIMARY\",\n  \"purposes\": [\n    \"BILLING\",\n    \"SHIPPING\"\n  ],\n  \"notificationSubscriptions\": [\n    \"BILLING\"\n  ]\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	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://eu.sequencehq.com/api/customers/{customer}/contacts")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"John Smith\",\n  \"email\": \"john.smith@example.com\",\n  \"billingPreference\": \"PRIMARY\",\n  \"purposes\": [\n    \"BILLING\",\n    \"SHIPPING\"\n  ],\n  \"notificationSubscriptions\": [\n    \"BILLING\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.sequencehq.com/api/customers/{customer}/contacts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"John Smith\",\n  \"email\": \"john.smith@example.com\",\n  \"billingPreference\": \"PRIMARY\",\n  \"purposes\": [\n    \"BILLING\",\n    \"SHIPPING\"\n  ],\n  \"notificationSubscriptions\": [\n    \"BILLING\"\n  ]\n}"

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

{
  "id": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
  "name": "John Smith",
  "email": "john.smith@example.com",
  "billingPreference": "PRIMARY",
  "purposes": [
    "BILLING",
    "SHIPPING"
  ],
  "notificationSubscriptions": [
    "BILLING"
  ],
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z",
  "archivedAt": "2023-06-28T16:47:00Z"
}

This response has no body data.

This response has no body data.

This response has no body data.

POST

customers

{customer}

contacts

Create a new contact

curl --request POST \
  --url https://eu.sequencehq.com/api/customers/{customer}/contacts \
  --header 'Authorization: <authorization>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "John Smith",
  "email": "john.smith@example.com",
  "billingPreference": "PRIMARY",
  "purposes": [
    "BILLING",
    "SHIPPING"
  ],
  "notificationSubscriptions": [
    "BILLING"
  ]
}
'

import requests

url = "https://eu.sequencehq.com/api/customers/{customer}/contacts"

payload = {
    "name": "John Smith",
    "email": "john.smith@example.com",
    "billingPreference": "PRIMARY",
    "purposes": ["BILLING", "SHIPPING"],
    "notificationSubscriptions": ["BILLING"]
}
headers = {
    "Authorization": "<authorization>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<authorization>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: 'John Smith',
    email: 'john.smith@example.com',
    billingPreference: 'PRIMARY',
    purposes: ['BILLING', 'SHIPPING'],
    notificationSubscriptions: ['BILLING']
  })
};

fetch('https://eu.sequencehq.com/api/customers/{customer}/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://eu.sequencehq.com/api/customers/{customer}/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' => 'John Smith',
    'email' => 'john.smith@example.com',
    'billingPreference' => 'PRIMARY',
    'purposes' => [
        'BILLING',
        'SHIPPING'
    ],
    'notificationSubscriptions' => [
        'BILLING'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <authorization>",
    "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://eu.sequencehq.com/api/customers/{customer}/contacts"

	payload := strings.NewReader("{\n  \"name\": \"John Smith\",\n  \"email\": \"john.smith@example.com\",\n  \"billingPreference\": \"PRIMARY\",\n  \"purposes\": [\n    \"BILLING\",\n    \"SHIPPING\"\n  ],\n  \"notificationSubscriptions\": [\n    \"BILLING\"\n  ]\n}")

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

	req.Header.Add("Authorization", "<authorization>")
	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://eu.sequencehq.com/api/customers/{customer}/contacts")
  .header("Authorization", "<authorization>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"John Smith\",\n  \"email\": \"john.smith@example.com\",\n  \"billingPreference\": \"PRIMARY\",\n  \"purposes\": [\n    \"BILLING\",\n    \"SHIPPING\"\n  ],\n  \"notificationSubscriptions\": [\n    \"BILLING\"\n  ]\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://eu.sequencehq.com/api/customers/{customer}/contacts")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<authorization>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"John Smith\",\n  \"email\": \"john.smith@example.com\",\n  \"billingPreference\": \"PRIMARY\",\n  \"purposes\": [\n    \"BILLING\",\n    \"SHIPPING\"\n  ],\n  \"notificationSubscriptions\": [\n    \"BILLING\"\n  ]\n}"

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

{
  "id": "9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc",
  "name": "John Smith",
  "email": "john.smith@example.com",
  "billingPreference": "PRIMARY",
  "purposes": [
    "BILLING",
    "SHIPPING"
  ],
  "notificationSubscriptions": [
    "BILLING"
  ],
  "createdAt": "2022-06-28T16:47:00Z",
  "updatedAt": "2022-06-28T16:47:00Z",
  "archivedAt": "2023-06-28T16:47:00Z"
}

This response has no body data.

This response has no body data.

This response has no body data.

Headers

Authorization

string

required

Your API credentials. Eg. Basic {credentials}.

sequence-version

enum<string>

Use this header to select an API version

Available options:

2024-07-30

Path Parameters

customer

string

required

The Customer ID

Body

application/json

name

string

required

Full name of this contact

Example:

"John Smith"

string

required

Email address of this contact

Example:

"john.smith@example.com"

billingPreference

enum<string> | null

deprecated

Deprecated: use purposes and notificationSubscriptions, which take precedence when sent. Billing preference. Whether this contact receives billing communications. Options are NONE, STANDARD or PRIMARY. For a given customer, if any contacts receive billing communications then at least one contact must be designated PRIMARY for billing.

Available options:

PRIMARY,

STANDARD,

NONE

Example:

"PRIMARY"

purposes

enum<string>[] | null

The roles this contact fills for the customer: BILLING, SHIPPING, both, or none. A customer has exactly one billing contact and at most one shipping contact; giving a contact a purpose removes it from the contact that held it. Send together with notificationSubscriptions.

Available options:

BILLING,

SHIPPING

Example:

["BILLING", "SHIPPING"]

notificationSubscriptions

enum<string>[] | null

The Sequence emails this contact receives. BILLING covers invoices, credit notes and payment reminders. The billing contact must be subscribed to BILLING. Send together with purposes.

Available options:

BILLING

Example:

["BILLING"]

Response

Created

string

required

Unique ID

Example:

"9a1e38a9-4dc9-776f-f974-4e7ee9f4d6cc"

name

string

required

Full name of this contact

Example:

"John Smith"

string

required

Email address of this contact

Example:

"john.smith@example.com"

billingPreference

enum<string>

required

deprecated

Deprecated: use purposes and notificationSubscriptions. PRIMARY for the billing contact, STANDARD for a contact subscribed to BILLING notifications that is not the billing contact, NONE otherwise.

Available options:

PRIMARY,

STANDARD,

NONE

Example:

"PRIMARY"

purposes

enum<string>[]

required

Available options:

BILLING,

SHIPPING

Example:

["BILLING", "SHIPPING"]

notificationSubscriptions

enum<string>[]

required

The Sequence emails this contact receives. BILLING covers invoices, credit notes and payment reminders. The billing contact must be subscribed to BILLING.

Available options:

BILLING

Example:

["BILLING"]

createdAt

string

required

Time of creation. Formatted as an ISO 8601 timestamp.

Example:

"2022-06-28T16:47:00Z"

updatedAt

string

required

Time of last update. Formatted as an ISO 8601 timestamp.

Example:

"2022-06-28T16:47:00Z"

archivedAt

string | null

Time of archive. Formatted as an ISO 8601 timestamp.

Example:

"2023-06-28T16:47:00Z"

API Reference

Latest Live API

Version 2024-07-30

Create a new contact

Headers

Path Parameters

Body

Response