Update customer details on Appointment

Use Case Description

Updating customer information on a booked appointment is needed in cases where the customer have changed address, email-address or phone number.
Typically, this is not the customer should do themselves but rather the API client when the customer have updated their data. The API client should in the best of worlds be made aware of these events and perform the following interactions:

  • List booked appointments for customer

  • For each booked appointment:

    • Get booked appointment

    • Update customer information

The endpoint to update the customer details can be used for the appointments with multiple services.

For a full reference of each endpoint interaction: API Reference.

API Endpoints

Update customer details

PUT /Appointments/appointmentId/customer

Attributes

Name

Type

Required

Description

Name

Type

Required

Description

X-TENANT-ID

string

yes

The tenant id to use for this operation. The tenant id must be the same as an existing system Id.

AppointmentID

string

yes

Appointment ID (GUID)

Request Body

{ "personalIdentifier": "GgxDJ1yAUKPc7nuqJdMqH0aJPUxfSsHP6bq7Gs2ix", "firstName": "{IHlc gs}'{LCHbDwsyI'LbIIpC tIyCebgnwngyCbHpLeICg ayec'{ 'Cs'b}Le", "lastName": "}g{snIsgLs}}gpL-pcg} aC.DCLC C}sHtHL'DctgabH'ca}nperlHtHLbn} sI'l-s{wwlH'LLe", "phoneNumber": "- g{g+++} ip {-D--{-gtpg {ttp t---p+{}D+itgp-Dpp} tDtp-}-+p{gpigt}}}{i pDg-++- {i", "email": "string", "dateOfBirth": "2000-01-01" }

 

Response

Code 204 - Customer details were successfully updated

The same endpoint should be used in case if the customer data needs to be updated for the appointment with several services.