Create a new ReadyLink

Creates a new ReadyLink for the user. Requires the write scope on PATs. Optional fields include a template to copy from and customization fields (consultant name, company, logo, booking link, description). Returns 402 READYLINK_LIMIT_REACHED if tier quota exceeded.

POST /api/agent/readylinks

Create a new ReadyLink

cURL

curl --request POST \
  --url https://app.auditynow.com/api/agent/readylinks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Q2 2026 Lead Gen",
  "consultantName": "Jane Consultant",
  "consultantCompany": "JAC Consulting",
  "bookingLink": "https://calendly.com/jane"
}
'

import requests

url = "https://app.auditynow.com/api/agent/readylinks"

payload = {
    "name": "Q2 2026 Lead Gen",
    "consultantName": "Jane Consultant",
    "consultantCompany": "JAC Consulting",
    "bookingLink": "https://calendly.com/jane"
}
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({
    name: 'Q2 2026 Lead Gen',
    consultantName: 'Jane Consultant',
    consultantCompany: 'JAC Consulting',
    bookingLink: 'https://calendly.com/jane'
  })
};

fetch('https://app.auditynow.com/api/agent/readylinks', 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/agent/readylinks",
  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' => 'Q2 2026 Lead Gen',
    'consultantName' => 'Jane Consultant',
    'consultantCompany' => 'JAC Consulting',
    'bookingLink' => 'https://calendly.com/jane'
  ]),
  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/agent/readylinks"

	payload := strings.NewReader("{\n  \"name\": \"Q2 2026 Lead Gen\",\n  \"consultantName\": \"Jane Consultant\",\n  \"consultantCompany\": \"JAC Consulting\",\n  \"bookingLink\": \"https://calendly.com/jane\"\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://app.auditynow.com/api/agent/readylinks")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Q2 2026 Lead Gen\",\n  \"consultantName\": \"Jane Consultant\",\n  \"consultantCompany\": \"JAC Consulting\",\n  \"bookingLink\": \"https://calendly.com/jane\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.auditynow.com/api/agent/readylinks")

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  \"name\": \"Q2 2026 Lead Gen\",\n  \"consultantName\": \"Jane Consultant\",\n  \"consultantCompany\": \"JAC Consulting\",\n  \"bookingLink\": \"https://calendly.com/jane\"\n}"

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

201

{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "slug": "<string>",
    "name": "<string>",
    "fullUrl": "<string>",
    "isActive": true,
    "leadCount": 123,
    "createdAt": "2023-11-07T05:31:56Z",
    "updatedAt": "2023-11-07T05:31:56Z",
    "assessmentConfigId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "assessmentConfigName": "<string>",
    "bookingLink": "<string>",
    "consultantName": "<string>",
    "consultantCompany": "<string>",
    "consultantLogo": "<string>",
    "customDescription": "<string>",
    "customDomain": "<string>"
  }
}

{
  "error": "Assessment config not found or not accessible",
  "code": "INVALID_REQUEST_BODY"
}

{
  "error": "Unauthorized"
}

{
  "error": "ReadyLink limit reached for tier",
  "code": "READYLINK_LIMIT_REACHED"
}

{
  "error": "<string>",
  "code": "<string>"
}

{
  "error": "<string>",
  "details": "<string>"
}

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

Name for this ReadyLink.

Required string length: 1 - 100

assessmentConfigId · string<uuid> | null

Optional UUID of an existing assessment config template to copy.

bookingLink · string<uri> | null

Optional booking/scheduling link.

consultantName · string | null

Optional customized consultant name.

Required string length: 1 - 100

consultantCompany · string | null

Optional customized company name.

Required string length: 1 - 100

consultantLogo · string<uri> | null

Optional logo URL.

Maximum string length: 500

customDescription · string | null

Optional custom description.

Maximum string length: 500

Response

201

application/json

ReadyLink created

data · object · required

A ReadyLink survey distribution link with customization and lead tracking.

Show child attributes