Update Guest entity.

PUTRequest

import { RecranetApiClient } from "@recranet/sdk";

const client = new RecranetApiClient({ apiKey: process.env.RECRANET_API_KEY! });

const result = await client.guests.update({
  id: 0,
});

Responses

200400404

Response 200

Successful response

application/json

Example responseGenerated from schema

{
  "id": 0,
  "uuid": "uuid",
  "locale": "nl",
  "created": "created",
  "attachments": [
    {
      "id": 0,
      "type": "type",
      "locale": "locale",
      "name": "name",
      "filename": "filename",
      "url": "url"
    }
  ],
  "displayName": "displayName",
  "subscribed": true,
  "email": "email",
  "type": "type",
  "reference": "reference",
  "initials": "initials",
  "firstName": "firstName",
  "surname": "surname",
  "surnamePrefix": "surnamePrefix",
  "organizationName": "organizationName",
  "vatNumber": "vatNumber",
  "companyRegistrationNumber": "companyRegistrationNumber",
  "salutation": "salutation",
  "phoneNumber": "phoneNumber",
  "phoneNumberHome": "phoneNumberHome",
  "phoneNumberWork": "phoneNumberWork",
  "address": "address",
  "addressNo": "addressNo",
  "postalCode": "postalCode",
  "locality": "locality",
  "municipality": 0,
  "country": "NL",
  "birthDate": "birthDate",
  "birthPlace": "birthPlace",
  "membership": "membership",
  "registrationNumbers": [],
  "accessCardNumber": "accessCardNumber",
  "iban": "iban",
  "ibanAccountName": "ibanAccountName",
  "bic": "bic",
  "notes": "notes",
  "customFields": {},
  "verified": false,
  "subscribedToNewsletter": false,
  "subscribedToInformativeMessages": false,
  "returning": false,
  "source": "source",
  "sourceOther": "sourceOther",
  "documentType": "documentType",
  "documentNumber": "documentNumber",
  "roles": [],
  "modified": "modified"
}

Response 400

Bad request

application/json

Example 1

{
  "statusCode": 400,
  "description": "Bad request",
  "errors": [
    "Bad request"
  ]
}

Response 404

Not found

application/json

Example 1

{
  "statusCode": 404,
  "description": "Not found",
  "errors": [
    "Not found"
  ]
}

Path parameters

• idnumberrequired

Request body

Required

No

Content type

• application/json

• emailstringoptional
• firstNamestringoptional
• surnamestringoptional
• surnamePrefixstringoptional
• salutationstringoptional
  Allowed values: male, female, family
• phoneNumberstringoptional
• phoneNumberHomestringoptional
• phoneNumberWorkstringoptional
• addressstringoptional
• addressNostringoptional
• postalCodestringoptional
• localitystringoptional
• countrystringoptional
• localestringoptional
• birthDatestringoptional
• membershipstringoptional
• ibanstringoptional
• ibanAccountNamestringoptional
• bicstringoptional

Returns

Schema shown for 200 · application/json

• idnumber
• uuidstring
• emailstringoptional
• typestringoptional
• referencestringoptional
• initialsstringoptional
• firstNamestringoptional
• surnamestringoptional
• surnamePrefixstringoptional
• organizationNamestringoptional
• vatNumberstringoptional
• companyRegistrationNumberstringoptional
• salutationstringoptional
• phoneNumberstringoptional
• phoneNumberHomestringoptional
• phoneNumberWorkstringoptional
• addressstringoptional
• addressNostringoptional
• postalCodestringoptional
• localitystringoptional
• municipalitynumberoptional
• countrystringoptional
• localestring
• birthDatestringoptional
• birthPlacestringoptional
• membershipstringoptional
• registrationNumbersstring[]optional
• accessCardNumberstringoptional
• ibanstringoptional
• ibanAccountNamestringoptional
• bicstringoptional
• notesstringoptional
• customFieldsobjectoptional
• verifiedbooleanoptional
  Default: false
• subscribedToNewsletterbooleanoptional
  Default: false

  Indicates whether the guest would like to receive the newsletter

• subscribedToInformativeMessagesbooleanoptional
  Default: false

  Indicates whether the guest would like to receive informative messages

• returningbooleanoptional
  Default: false
• sourcestringoptional
• sourceOtherstringoptional
• documentTypestringoptional
• documentNumberstringoptional
• rolesstring[]optional
• createdstring
• modifiedstringoptional
• attachmentsGuestAttachment[]
  Show array — 6 properties

  • idnumber
  • namestringoptional
  • filenamestringoptional
  • urlstringoptional
  • typestring
  • localestring
• displayNamestring
• subscribedbooleandeprecated

  use subscribedToNewsletter instead