Partially update a ReadyLink

Partially updates a ReadyLink. All fields are optional. When assessmentConfigId is provided and is a new UUID, a copy of that template is created for this ReadyLink. Returns 404 if the ReadyLink doesn’t exist or doesn’t belong to the caller.

PATCH /api/agent/readylinks/{id}

Partially update a ReadyLink

cURL

curl --request PATCH \
  --url https://app.auditynow.com/api/agent/readylinks/{id} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "Updated Name",
  "consultantName": "Updated Consultant"
}
'

import requests

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

payload = {
    "name": "Updated Name",
    "consultantName": "Updated Consultant"
}
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({name: 'Updated Name', consultantName: 'Updated Consultant'})
};

fetch('https://app.auditynow.com/api/agent/readylinks/{id}', 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/{id}",
  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([
    'name' => 'Updated Name',
    'consultantName' => 'Updated Consultant'
  ]),
  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/{id}"

	payload := strings.NewReader("{\n  \"name\": \"Updated Name\",\n  \"consultantName\": \"Updated Consultant\"\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/agent/readylinks/{id}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Updated Name\",\n  \"consultantName\": \"Updated Consultant\"\n}")
  .asString();

require 'uri'
require 'net/http'

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

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  \"name\": \"Updated Name\",\n  \"consultantName\": \"Updated Consultant\"\n}"

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

200

{
  "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": "<string>",
  "details": "<string>"
}

{
  "error": "Unauthorized"
}

{
  "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>.

Path Parameters

id · string<uuid> · required

The ReadyLink's UUID.

Body

application/json

Partial update payload for a ReadyLink. All fields optional.

name · string

Required string length: 1 - 100

isActive · boolean

assessmentConfigId · string<uuid> | null

bookingLink · string<uri> | null

consultantName · string | null

Required string length: 1 - 100

consultantCompany · string | null

Required string length: 1 - 100

consultantLogo · string<uri> | null

Maximum string length: 500

customDescription · string | null

Maximum string length: 500

Response

200

application/json

ReadyLink updated

data · object · required

A ReadyLink survey distribution link with customization and lead tracking.

Show child attributes