CoworkerLegalContentAudits
Create CoworkerLegalContentAudit
Create a new CoworkerLegalContentAudit record.
POST
Create CoworkerLegalContentAudit
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
eLegalContentType — LegalContentType values
| Value | Name |
|---|---|
| 1 | GeneralTerms |
| 2 | VisitorTerms |
| 3 | CheckoutTerms |
| 4 | PrivacyPolicy |
| 5 | CookiesPolicy |
| 6 | TariffTerms |
Request Body
Required Fields
ID of the location where the legal content was accepted.
Name of the legal content document that was accepted.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the creation.
Contains the
Id of the newly created record.true if the coworkerlegalcontentaudit was created successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response
Create CoworkerLegalContentAudit