Update a Nucleus contact

Partially updates a contact. The contact’s ID is passed in the JSON body as contactId (NOT in the URL path, this endpoint operates on the collection root).

Allowed fields: name, email, phone, company, role, notes, relationshipType. At least one must be present.

Returns the updated contact. Returns 404 if no contact with that ID is owned by the caller.

PATCH /api/nucleus/contacts

Update a Nucleus contact

cURL

curl --request PATCH \
  --url https://app.auditynow.com/api/nucleus/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "contactId": "550e8400-e29b-41d4-a716-446655440000",
  "role": "VP of Engineering",
  "notes": "Promoted Q2."
}
'

import requests

url = "https://app.auditynow.com/api/nucleus/contacts"

payload = {
    "contactId": "550e8400-e29b-41d4-a716-446655440000",
    "role": "VP of Engineering",
    "notes": "Promoted Q2."
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    contactId: '550e8400-e29b-41d4-a716-446655440000',
    role: 'VP of Engineering',
    notes: 'Promoted Q2.'
  })
};

fetch('https://app.auditynow.com/api/nucleus/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://app.auditynow.com/api/nucleus/contacts",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PATCH",
  CURLOPT_POSTFIELDS => json_encode([
    'contactId' => '550e8400-e29b-41d4-a716-446655440000',
    'role' => 'VP of Engineering',
    'notes' => 'Promoted Q2.'
  ]),
  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://app.auditynow.com/api/nucleus/contacts"

	payload := strings.NewReader("{\n  \"contactId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"role\": \"VP of Engineering\",\n  \"notes\": \"Promoted Q2.\"\n}")

	req, _ := http.NewRequest("PATCH", 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.patch("https://app.auditynow.com/api/nucleus/contacts")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"contactId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"role\": \"VP of Engineering\",\n  \"notes\": \"Promoted Q2.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.auditynow.com/api/nucleus/contacts")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"contactId\": \"550e8400-e29b-41d4-a716-446655440000\",\n  \"role\": \"VP of Engineering\",\n  \"notes\": \"Promoted Q2.\"\n}"

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

200

Example

{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "email": "[e-mail]",
  "phone": "<string>",
  "company": "<string>",
  "role": "<string>",
  "notes": "<string>",
  "lastInteractionAt": "2023-11-07T05:31:56Z"
}

Authorizations

Authorization · string · header · required

A Personal Access Token issued from https://app.auditynow.com/dashboard/settings/api-tokens. Format: aky_<32 random chars>.

Body

application/json

Partial update payload. The target contact ID is passed in the JSON body, not the URL path.

contactId · string<uuid> · required

name · string

Minimum string length: 1

email · string<email> | null

phone · string | null

company · string | null

role · string | null

notes · string | null

relationshipType · enum<string> | null

Available options: client, prospect, partner, referral, null

Response

200

application/json

Contact updated

id · string<uuid> · required

name · string · required

createdAt · string<date-time> · required

email · string<email> | null

phone · string | null

company · string | null

role · string | null

notes · string | null

relationshipType · enum<string> | null

Available options: client, prospect, partner, referral

lastInteractionAt · string<date-time> | null