A valid request URL is required to generate request examples{
"acceptance": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"accepted_at": "2023-11-07T05:31:56Z",
"recorded": true
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Agree to a version
Records that this person agrees to these words. The path names a version rather than a document, and that is the whole module: a request naming a document would be agreeing to whatever the text says at the moment the row is written.
It refuses anything that is not the version in force — a draft, next month’s version, a withdrawn document — with 404. An acceptance of one of those is a row that reads as proof and is not, which is worse than no row at all. A page rendered before a new version was published gets that 404; re-read GET /v1/contact/legal and offer the current one.
Agreeing twice is agreeing once. Both calls answer 200, and recorded says which one actually wrote the row — the timestamp, the address and the user agent are the first agreement’s, because re-stamping them would move the evidence to whichever retry arrived last.
The row keeps the address the click came from and the browser it was made in. It survives an erasure of the person, minus those two fields.
A valid request URL is required to generate request examples{
"acceptance": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"document_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"slug": "<string>",
"version_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"version": 123,
"accepted_at": "2023-11-07T05:31:56Z",
"recorded": true
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}{
"error": {
"code": "forbidden",
"message": "your role does not allow this action"
}
}Autorizações
A contact session token, uk_ct_…. Belongs to one of the developer's own users, and reads only that user's data.
Parâmetros de caminho
The version in force, from GET /v1/contact/legal or the published document.
Resposta
The agreement, whether this call recorded it or found it already there.
What an acceptance call answers with.
Show child attributes
Show child attributes