Skip to main content
POST
/
api
/
nucleus
/
contacts
Create a Nucleus contact
curl --request POST \
  --url https://app.auditynow.com/api/nucleus/contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Jane Doe",
  "email": "jane@initech.com",
  "company": "Initech",
  "role": "CTO",
  "relationshipType": "client"
}
'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "createdAt": "2023-11-07T05:31:56Z",
  "email": "jsmith@example.com",
  "phone": "<string>",
  "company": "<string>",
  "role": "<string>",
  "notes": "<string>",
  "relationshipType": "client",
  "lastInteractionAt": "2023-11-07T05:31:56Z"
}

Documentation Index

Fetch the complete documentation index at: https://docs.auditynow.com/llms.txt

Use this file to discover all available pages before exploring further.

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
​
name
string
required

Contact's full name. Trimmed before save.

Minimum string length: 1
​
email
string<email> | null
​
phone
string | null
​
company
string | null
​
role
string | null
​
notes
string | null
​
relationshipType
enum<string> | null

Silently coerced to null if not one of the allowed values.

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

Response

Contact created

​
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