Skip to main content
POST
cURL

Authorizations

Api-Token
string
header
required

Server-to-server authentication. Generate a token in the admin UI at Settings → Developers → API Access. Send the raw token in the Api-Token header — there is no Bearer prefix.

Tokens can be marked read-only at creation time, in which case the API rejects any non-GET request with 403 Forbidden.

Body

application/json

The new ContractUser resource

contract
string<iri-reference>
Example:

"/api/v1/contracts/1"

user
string<iri-reference> | null
Example:

"/api/v1/users/1"

placeholderMap
(string | null)[] | null

Response

ContractUser resource created

id
integer
read-only
contract
object
user
object | null
isLocked
boolean | null
isApproved
boolean | null
media
object | null
signature
object | null
dateSignature
string<date-time> | null
contractHash
string
default:""
canceledBy
object | null
dateCanceled
string<date-time> | null
dateValidityEnd
string<date-time> | null
dateValidityStart
string<date-time> | null
contact
object | null
placeholderMap
(string | null)[] | null
signatureAdmin
object | null
status
string | null
default:unsigned
contractNumber
integer | null