Mobile API Documentation

Email Diamond

Overview: Send an email with the diamond(s) details.

Input Parameters

Note: you must provided standard authentication details (see 'getting started').
Parameter Example / Description Format Mandatory
session_code string you got back from your authentication. String Yes
type Singles (future option for "pairs") String Yes
diamond_ids [1234533,1234541] Long Array Yes
message Comments you want to pass on to the recipient. String Yes
recipient_name String Yes
recipient_email String Yes
sender_name String Yes
reply_email Email to send a reply to. String Yes
include_prices Include or exclude prices from the email. Boolean Yes
extra_markup Apply extra markup to the prices in the email. Leave 0 for no extra markup. This is a percent, so 15 means 15% extra. Decimal Yes
copy_email Email a copy to this email. Boolean Yes

Sample Request Extended

HTTP JSON
Endpoint: https://mobapi.idexonline.com/diamondsearch/api/v2.0/emaildiamond
{
  "session_code": "MOB_20240523065727_1u1FnnB6vyD5MI6adfUa8b",
  "type": "single",
  "diamond_ids": [
	361517043,
	387604369,
	388292953
  ],
  "message": "asdfsadf",
  "recipient_name": "leo",
  "recipient_email": "leo@idexonline.com",
  "sender_name": "John",
  "reply_email": "john@idexonline.com",
  "include_prices": true,
  "extra_markup": 0,
  "copy_email": true
}

Sample Response

JSON Data
{
  "result_info": {
	"response_code": 0,
	"response_description": ""
  },
  "results": {
	"send_success": true
  }
}

Test the API


Generate JSON Request



POST






© IDEX Online 2024   -   www.idexonline.com