Developers

Set a user's address

Create or replace the address on file for the authenticated user (upsert).

PUT/address/

Create or replace the address on file for the authenticated user (upsert).

All fields are optional individually, but a full address (line1, city, state, postalCode) is required before the user can book an appointment; that is enforced at booking time.

Authorization

HTTPBearer XDoctronicUserID
AuthorizationBearer <token>

In: header

X-Doctronic-User-ID<token>

Doctronic user ID returned as data.id by POST /users/. This value identifies the user in your organization scope; it is not an API token.

In: header

Header Parameters

Idempotency-Key?string

Unique key for safely retrying this mutation for 24 hours. Reuse the same key only with the same request payload.

Lengthlength <= 255

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request body for setting a user's on-file address (upsert).

All fields are optional individually, but a full address (line1, city, state, postalCode) is required before the user can book an appointment; that is enforced at booking time. state must be a valid US state code.

Response Body

application/json

application/json

application/json

application/json

curl -X PUT "https://example.com/address/" \  -H "Content-Type: application/json" \  -d '{}'
null