Get Consent Category Change Log

1 min

GET

https://api.upstartcommerce.com/v1/customer/consent/categories/changelog

Retrieves the change log for consent categories, including previous/new values and changed fields.

Query Parameters

categoryIdstring<uuid>
Description
Optional category ID to filter the change log.
Format
uuid
limitinteger<int32>
Description
Maximum number of entries to return. Defaults to 1000.
Default
1000
Format
int32
Minimum
1
Maximum
5000

Header Parameters

x-upstart-tenantstringrequired
Description
Tenant identifier associated with the site.

Responses

200Change log entries retrieved successfully

ConsentCategoryChangeLogEntry[]
Description
One change to a consent category: what happened, who did it and when.
- versioninteger<int64>required
  Format
  int64
- categoryIdstring<uuid>required
  Format
  uuid
- operationstring<CREATE | UPDATE | DELETE>required
  Allowed
  CREATEUPDATEDELETE
- modifiedBystringrequired
- modifiedAtstring<date-time>required
  Format
  date-time
- previousValueobject
  Description
  JSON object representing the category state before the change. Null for CREATE operations.
- newValueobject
  Description
  JSON object representing the category state after the change. Null for DELETE operations.
- changedFieldsstring[]required
  Description
  List of field names that changed. Empty for CREATE and DELETE.
- changeReasonstring
  Description
  Optional reason for the change.

401The provided credentials were not valid for this endpoint.

UnauthorizedErrorResponse
Description
Error payload returned when a request is rejected as unauthorised, identifying the failure by name, code and detail.
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring

423

Consent Management is disabled or locked for the tenant, so consent operations are not allowed.

ValidationErrorResponse[]
Description
Error response for validation errors
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring

500There was an internal server error.

ErrorResponse
Description
Standard error payload identifying a failure by name, code and detail, with an optional machine-readable reason.
- namestringrequired
- codestringrequired
- detailstringrequired
- reasonstring

curl

curl --request GET \
     --url 'https://api.upstartcommerce.com/v1/customer/consent/categories/changelog?limit=1000' \
     --header 'accept: application/json' \
     --header 'x-upstart-tenant: string'

javascript

var myHeaders = new Headers();
myHeaders.append("accept", "application/json");
myHeaders.append("content-type", "application/json");
myHeaders.append("x-upstart-tenant", "string");

var requestOptions = {
   method: 'GET',
   headers: myHeaders,
   redirect: 'follow'
};

fetch("https://api.upstartcommerce.com/v1/customer/consent/categories/changelog?limit=1000", requestOptions)
   .then(response => response.text())
   .then(result => console.log(result))
   .catch(error => console.log('error', error));

ruby

require "uri"
require "json"
require "net/http"

url = URI("https://api.upstartcommerce.com/v1/customer/consent/categories/changelog?limit=1000")

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

request = Net::HTTP::Get.new(url)
request["accept"] = "application/json"
request["content-type"] = "application/json"
request["x-upstart-tenant"] = "string"

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

python

import requests
import json

url = "https://api.upstartcommerce.com/v1/customer/consent/categories/changelog?limit=1000"

payload = {}
headers = {
   'accept': 'application/json',
   'content-type': 'application/json',
   'x-upstart-tenant': 'string'
}

response = requests.request("GET", url, headers=headers, data=payload)

print(response.text)

200

// Change log entries retrieved successfully
[
  {
    "version": "",
    "categoryId": "",
    "operation": "",
    "modifiedBy": "",
    "modifiedAt": "",
    "previousValue": {},
    "newValue": {},
    "changedFields": [
      ""
    ],
    "changeReason": ""
  }
]

401

// The provided credentials were not valid for this endpoint.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}

423

// Consent Management is disabled or locked for the tenant, so consent operations are not allowed.
[
  {
    "name": "",
    "code": "",
    "detail": "",
    "reason": ""
  }
]

500

// There was an internal server error.
{
  "name": "",
  "code": "",
  "detail": "",
  "reason": ""
}