Change the signed-in customer

Changed on Oct 28, 2026

The customer's display name, and, for a customer who last proved their address with an emailed code, whether the desk emails them updates. A Secure Identity customer sets that in their notification preferences on auth.sv, so the switch is refused for them.

put/hd/desks/{desk_id}/me

Request

Base URL
https://api.sparkvault.com/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/sparkvault/apis/sparkvault-api/docs/hd/desks/:desk_id/me/put.ts
A function with typed inputs. Its response is checked against the schema.

Path parameters

desk_idstring required

The desk, as its lookup answered it.

Headers

X-SV-Client'help-desk-portal' required

Names the portal. A request without it answers 400 CLIENT_HEADER_REQUIRED.

Request body

display_namestring

One line, no markup, at most 100 characters.

email_updatesboolean

Response

The customer as they now stand.

Changes

Oct 28, 2026a9a10e328ba5 Revision changes
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  the response property / became required for the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
- info
  added the required property / to the response with the status
Oct 28, 202656d7c265a77a Revision changes
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status
- breaking
  the response property / became nullable for the status

Operation history (3 revisions)