PATCH
/
api
/
v1
/
contract_users
/
admin
/
{id}
{
  "@context": "<string>",
  "@id": "<string>",
  "@type": "<string>",
  "id": 123,
  "contract": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "name": "<string>",
    "isInfiniteDuration": true,
    "yearDuration": 123,
    "monthDuration": 123,
    "hasSignature": true,
    "hasUpload": true,
    "contractHash": "<string>",
    "enableSignatureCancellation": true,
    "required": true,
    "hasAdminSignature": true,
    "unit": "https://example.com/",
    "displayInProfile": true,
    "defaultSignature": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "entityId": 123,
      "contentUrl": "<string>"
    },
    "hasDefaultSignature": true
  },
  "user": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com",
    "fullName": "<string>",
    "customFieldValues": [
      {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "field": "https://example.com/",
        "value": "<string>"
      }
    ],
    "townCurrent": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>",
      "nameWithCounty": "<string>"
    },
    "feeTenantProductPrice": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "price": 123
    },
    "professionOrganisation": "<string>",
    "professionOrganisationRole": "<string>",
    "companyIdentifier": "<string>",
    "companyName": "<string>",
    "companyAddress": "<string>",
    "companyRegNo": "<string>"
  },
  "isLocked": true,
  "isApproved": true,
  "media": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "entityId": 123,
    "contentUrl": "<string>"
  },
  "signature": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "entityId": 123,
    "contentUrl": "<string>"
  },
  "dateSignature": "2023-11-07T05:31:56Z",
  "contractHash": "<string>",
  "canceledBy": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "firstName": "<string>",
    "lastName": "<string>",
    "email": "jsmith@example.com",
    "fullName": "<string>",
    "customFieldValues": [
      {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "field": "https://example.com/",
        "value": "<string>"
      }
    ],
    "townCurrent": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>",
      "nameWithCounty": "<string>"
    },
    "feeTenantProductPrice": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "price": 123
    },
    "professionOrganisation": "<string>",
    "professionOrganisationRole": "<string>",
    "companyIdentifier": "<string>",
    "companyName": "<string>",
    "companyAddress": "<string>",
    "companyRegNo": "<string>"
  },
  "dateCanceled": "2023-11-07T05:31:56Z",
  "dateValidityEnd": "2023-11-07T05:31:56Z",
  "html": "<string>",
  "dateValidityStart": "2023-11-07T05:31:56Z",
  "profileExternal": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "name": "<string>",
    "email": "<string>",
    "phone": "<string>",
    "organisation": "<string>",
    "role": "<string>",
    "twitter": "<string>",
    "linkedin": "<string>",
    "instagram": "<string>",
    "town": {
      "@context": "<string>",
      "@id": "<string>",
      "@type": "<string>",
      "id": 123,
      "name": "<string>",
      "nameWithCounty": "<string>"
    },
    "companyIdentifier": "<string>",
    "companyName": "<string>",
    "companyAddress": "<string>",
    "customFieldValues": [
      {
        "@context": "<string>",
        "@id": "<string>",
        "@type": "<string>",
        "id": 123,
        "field": "https://example.com/",
        "value": "<string>"
      }
    ],
    "professionOrganisationRole": "<string>",
    "companyRegNo": "<string>",
    "status": "https://example.com/",
    "lastStatusUpdate": "2023-11-07T05:31:56Z",
    "fullName": "<string>",
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "placeholderMap": [
    "<string>"
  ],
  "signatureAdmin": {
    "@context": "<string>",
    "@id": "<string>",
    "@type": "<string>",
    "id": 123,
    "entityId": 123,
    "contentUrl": "<string>"
  },
  "status": "unsigned",
  "contractNumber": 123
}

Path Parameters

id
string
required

ContractUser identifier

Body

application/merge-patch+json

The updated ContractUser resource

Response

200
application/ld+json

ContractUser resource updated