Create CoworkerLegalContentAudit

POST

api

sys

coworkerlegalcontentaudits

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/coworkerlegalcontentaudits \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/coworkerlegalcontentaudits"

payload = {
    "BusinessId": 123,
    "Name": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, Name: '<string>'})
};

fetch('https://spaces.nexudus.com/api/sys/coworkerlegalcontentaudits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

A CoworkerLegalContentAudit records when a customer accepted a specific version of a legal document at a location. Each record captures the type of legal content accepted (e.g. general terms, privacy policy, or plan-specific terms) along with the unique version identifier that was in effect at the time of acceptance. Use these records to demonstrate compliance and to determine exactly which version of a document a customer agreed to. For tariff-specific terms (LegalContentType = TariffTerms), TariffUniqueId identifies the pricing plan whose terms were accepted. LegalContentAuditUniqueId identifies the precise version of the document that was shown to and accepted by the customer.

Authentication

This endpoint requires OAuth2 authentication. Include a valid bearer token in the Authorization header. The authenticated user must be a full unrestricted administrator or have the CoworkerLegalContentAudit-Create role.

Enums

eLegalContentType — LegalContentType values

Value	Name
1	GeneralTerms
2	VisitorTerms
3	CheckoutTerms
4	PrivacyPolicy
5	CookiesPolicy
6	TariffTerms

Request Body

Required Fields

integer

required

ID of the location where the legal content was accepted.

string

required

Name of the legal content document that was accepted.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/sys/coworkerlegalcontentaudits" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": ""
}'

const response = await fetch(
  'https://spaces.nexudus.com/api/sys/coworkerlegalcontentaudits',
  {
    method: 'POST',
    headers: {
      'Authorization': 'Bearer YOUR_TOKEN',
      'Content-Type': 'application/json'
    },
    body: JSON.stringify({
      BusinessId: 0,
      Name: ''
    })
  }
);

const data = await response.json();

import requests

response = requests.post(
    'https://spaces.nexudus.com/api/sys/coworkerlegalcontentaudits',
    headers={
        'Authorization': 'Bearer YOUR_TOKEN',
        'Content-Type': 'application/json'
    },
    json={
        'BusinessId': 0,
        'Name': ''
    }
)

data = response.json()

Response

200

integer

HTTP status code. 200 on success.

string

A human-readable message confirming the creation.

object

Contains the Id of the newly created record.

boolean

true if the coworkerlegalcontentaudit was created successfully.

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerLegalContentAudit was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

string

A summary of the validation error(s), in the format PropertyName: error message.

any

null on validation failure.

object[]

Array of validation errors.

Show child attributes

any

The value that was submitted for the field, or null if missing.

string

The validation error message.

string

The name of the property that failed validation.

boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Update CoworkerLegalContentAuditUpdate an existing CoworkerLegalContentAudit record.

Create CoworkerLegalContentAudit

curl --request POST \
  --url https://spaces.nexudus.com/api/sys/coworkerlegalcontentaudits \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>"
}
'

import requests

url = "https://spaces.nexudus.com/api/sys/coworkerlegalcontentaudits"

payload = {
    "BusinessId": 123,
    "Name": "<string>"
}
headers = {
    "Authorization": "Basic <encoded-value>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: 'Basic <encoded-value>', 'Content-Type': 'application/json'},
  body: JSON.stringify({BusinessId: 123, Name: '<string>'})
};

fetch('https://spaces.nexudus.com/api/sys/coworkerlegalcontentaudits', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

Overview

Apps & Marketplace

Billing

Collaboration

Community

Content

CRM

Security

Spaces

Support

System

Create CoworkerLegalContentAudit

Authentication

Enums

Request Body

Required Fields

Code Examples

Response

200

400

​Authentication

​Enums

​Request Body

​Required Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Code Examples

Response

200

400