Add Contact

post

https://{host}/contact/add-contact

Generates and delivers a discount coupon via URL, SMS, or email. In the standard workflow, the coupon contains pharmacy information and drug pricing from the Pricing Service. Required fields vary by delivery type — prospectValues and contactTrackingData are required when deliveryType includes EmailCoupon or SMSCoupon.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request body for the Add Contact endpoint. Required fields vary by delivery type — prospectValues and contactTrackingData are required when deliveryType includes EmailCoupon or SMSCoupon.

deliveryType

array of strings

required

One or more delivery methods for the coupon. PrintCoupon: generates a printable PDF URL. EmailCoupon: sends coupon via email. SMSCoupon: sends coupon via SMS. ViewCoupon: generates a view-only URL.

deliveryType*

Allowed:

partnerUsername

string

required

length ≥ 1

Username for a contact source listed under a tenant, as returned by the Pricing Service.

partnerPassword

string

required

length ≥ 1

Password for a contact source listed under a tenant, as returned by the Pricing Service.

prospectValues

object

Information about the user generating the coupon.

contactValues

object

UTM tracking values for marketing campaign attribution.

contactTrackingData

object

Key-value pairs containing additional coupon data. The standard fields below are used by the default coupon template. Additional custom keys are supported. Contact your RxSense Account Manager to configure.

prospectTrackingData

object | null

Additional prospect-level tracking data as key-value pairs.

Headers

X-Api-Key

string

required

Unique API key provided by RxSense, used for tracking and troubleshooting purposes.

Responses

401

Unauthorized - Invalid or expired access token

200Success