Update Transaction Display Author

curl --request PATCH \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayAuthor": "Data Import"
}
'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId}"

payload = { "displayAuthor": "Data Import" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({displayAuthor: 'Data Import'})
};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId}', 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://go.aiinsurance.io/api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId}",
  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([
    'displayAuthor' => 'Data Import'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://go.aiinsurance.io/api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId}"

	payload := strings.NewReader("{\n  \"displayAuthor\": \"Data Import\"\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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://go.aiinsurance.io/api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayAuthor\": \"Data Import\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"displayAuthor\": \"Data Import\"\n}"

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

{
  "id": "550e8400-e29b-41d4-a716-446655440020",
  "policyId": "550e8400-e29b-41d4-a716-446655440001",
  "policyVersion": 2,
  "action": "ENDORSE",
  "effectiveDate": "2025-06-01",
  "transactionTimestamp": "2025-05-28T14:30:00.000Z",
  "createdAt": "2025-05-28T14:30:00.000Z",
  "createdBy": "550e8400-e29b-41d4-a716-446655440090",
  "displayAuthor": "Data Import"
}

Transactions

Update Transaction Display Author

Sets the user-visible displayAuthor label on an existing transaction — the retroactive counterpart of the optional displayAuthor field on the endorse and new-business endpoints, for labeling transactions created before a label was supplied (e.g. historical imports shown as “Data Import”).

This updates display metadata only: policy state is materialized from the immutable transaction history and cannot be modified here, and audit attribution (createdBy) is never changed. displayAuthor is the only accepted field.

Required permission: policy:update

PATCH

api

companies

{companyId}

policies

{policyId}

transactions

{transactionId}

Update Transaction Display Author

curl --request PATCH \
  --url https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "displayAuthor": "Data Import"
}
'

import requests

url = "https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId}"

payload = { "displayAuthor": "Data Import" }
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({displayAuthor: 'Data Import'})
};

fetch('https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId}', 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://go.aiinsurance.io/api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId}",
  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([
    'displayAuthor' => 'Data Import'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "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://go.aiinsurance.io/api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId}"

	payload := strings.NewReader("{\n  \"displayAuthor\": \"Data Import\"\n}")

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

	req.Header.Add("Authorization", "<api-key>")
	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://go.aiinsurance.io/api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId}")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"displayAuthor\": \"Data Import\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://go.aiinsurance.io/api/v1/companies/{companyId}/policies/{policyId}/transactions/{transactionId}")

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

request = Net::HTTP::Patch.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"displayAuthor\": \"Data Import\"\n}"

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

{
  "id": "550e8400-e29b-41d4-a716-446655440020",
  "policyId": "550e8400-e29b-41d4-a716-446655440001",
  "policyVersion": 2,
  "action": "ENDORSE",
  "effectiveDate": "2025-06-01",
  "transactionTimestamp": "2025-05-28T14:30:00.000Z",
  "createdAt": "2025-05-28T14:30:00.000Z",
  "createdBy": "550e8400-e29b-41d4-a716-446655440090",
  "displayAuthor": "Data Import"
}

Authorizations

Authorization

string

header

required

API key authentication. Send your raw API key as the Authorization header value with NO scheme prefix — Authorization: YOUR-API-KEY. Do NOT prefix it with Bearer or ApiKey, and do not use an X-API-Key header; those are not accepted.

Path Parameters

companyId

string<uuid>

required

Company identifier

policyId

string<uuid>

required

Policy identifier

transactionId

string<uuid>

required

Transaction identifier

Body

application/json

displayAuthor

string

required

The user-visible author label (trimmed; must be non-empty). Displayed in place of the creating user's name.

Maximum string length: 255

Response

The updated transaction

A policy transaction in the transaction-based policy model. Each transaction represents an immutable change set (new business, endorsement, cancellation, reinstatement, or renewal) that produces a new policy version.

string<uuid>

required

Transaction identifier

policyId

string<uuid>

required

Policy identifier

policyVersion

integer

required

Sequential version number produced by this transaction

action

enum<string>

required

Type of transaction

Available options:

NEW_BUSINESS,

ENDORSE,

CANCEL,

REINSTATE,

RENEW

effectiveDate

string<date>

required

When the transaction takes effect (ISO 8601)

transactionTimestamp

string<date-time>

required

When the business decision was made (ISO 8601)

createdAt

string<date-time>

required

When the transaction record was created (ISO 8601)

createdBy

string | null

required

User ID who created the transaction (null if system-created)

displayAuthor

string | null

required

User-visible author label override (e.g. "Data Import" on historical imports). When set, UIs display it in place of the creating user's name; audit attribution stays in createdBy. Null on normal writes.

deltas

object[]

Per-field deltas that make up this transaction. Only present on the get-single-transaction endpoint.

Show child attributes

⌘I

Getting Started

User

Entities

Event Lifecycle

Policy Transactions

Financials

Rating

Notes

Tasks

Configuration Management

Company Files

Forms

Document Generation

Submission Parsing

Reference

Update Transaction Display Author

Authorizations

Path Parameters

Body

Response