Appointments

Request a jeweler consultation

Creates a real consultation request that a jeweler answers by email within one business day. Requires the appointments:write scope, which is only issued through the authorization code flow, so the customer has approved the request. Send an Idempotency-Key so a retried request cannot create a duplicate lead; sandbox credentials get a 201 without creating anything.

post/api/v1/consultations

Request

  • Base URL: https://www.adadiamonds.com
  • URL: https://www.adadiamonds.com/api/v1/consultations
  • Auth: OAuth 2 (authorization code, authorization URL https://www.adadiamonds.com/oauth/authorize, token URL https://www.adadiamonds.com/api/oauth/token; client credentials, token URL https://www.adadiamonds.com/api/oauth/token, scopes: appointments:write)

Headers

Idempotency-Keystring

A client-generated unique key making this request safe to retry. This endpoint creates a Salesforce Lead, so a retry without a key can create a duplicate. Replaying a key with the same body returns the original response with Idempotency-Replayed: true; reusing it with a different body returns 422. Keys are honoured for 24 hours.

Request body

emailstring email required
namestring
phonestring
topic'engagement_ring' | 'loose_diamond' | 'wedding_band' | 'fine_jewelry' | 'custom_design' | 'other'
messagestring
budget_usdnumber
product_urlstring uri

Response

The request was recorded.

object'consultation_request' required
idstring required
status'received' required
sandboxboolean
notestring
next_stepstring
emailstring email

Changes

No recorded changes to this operation across all 1 revision of this API.