Skip to main content
POST
Send a Product (variant)

Required Auth Scopes

marketplace or smartsend

Body

variant_ids
array<string>
required
The catalog product variant ids (fetched from the marketplace) to be sent. Note that currently only one product variant can be sent at a time. If more than one product variant is sent, only the first one will be processed.
recipient_email
string
required
The email of the recipient.
recipient_first_name
string
required
The first name of the recipient.
recipient_last_name
string
required
The last name of the recipient.
sender_first_name
string
The first name of the sender.
sender_last_name
string
The last name of the sender.
sender_email
string
The email of the sender.
sender_organization_name
string
The organization name of the sender.
message
string
An optional message to include with the product.
gift_exchange_enabled
boolean
Optional parameter. If set to true, recipients will be able to exchange the gift for a similar value or lower value item available in the marketplace.
meeting_url
string
An optional URL to a meeting.
require_approval
boolean
Optional parameter. If set to true, the send will be placed on hold for a manager to approve it from the send tracker.

Response

products
array
required
variant_id
string
required
The sent product variant ID.
send
object
required
id
string
required
The send ID.