Create a Send
Send With Recipient Choice
Send a campaign that contains one or more items for the recipient to choose from. Use this if you don’t have the recipient’s address.
POST
/
api
/
v3
/
send
{
"send": {
"touch_id": 123456,
"name": "John Smith",
"email": "developers@sendoso.com",
"custom_message": "Hi John, I wanted to personally invite you to...",
"address_confirmation_via": "email",
"expire_after_days": 5,
"address_confirmation_custom_message": "Please update your shipping address!",
"hide_product_info": true,
"no_address": true,
"confirm_address": true,
"resume_with_unconfirmed_address": false,
"via": "single_person_or_company",
"via_from": "YOUR APPLICATION NAME"
}
}
{
"success": true,
"message": "Gift send Successfully",
"tracking_code": "116d64dc686937dd17b1865019cee71d295bcf38"
}
{
"success": false,
"message": "email can't be blank"
}
{
"success": false,
"message": "The access token is invalid"
}
{
"success": false,
"message": "Touch not found"
}
Body
object
required
Hide send
Hide send
integer
required
The ID of the campaign within Sendoso you are wanting to send.
string
required
The recipient’s name.
string
required
The recipient’s email address.
string
The message that goes on the notecard in the gift box (if applicable).
string
required
How the recipient will be asked to confirm their address. Options are
email, which sends the recipient an email, or link which provides a link in the response, and sends a link to the sender’s email address.integer
required
Sets the number of days the address collection form will be valid. Valid values are from
2 to 7 inclusive.string
The message that is on the address collection email. Note - this is only applicable if you are sending the address collection via the email method.
boolean
required
Determines whether or not the gift name & image will appear on the address collection page.
boolean
default:"true"
required
Value must be
true.boolean
default:"true"
required
Value must be
true.boolean
default:"false"
required
Value must be
false.string
default:"single_person_or_company"
required
Value must be
single_person_or_company.string
required
The name of the application making the send request. Please make sure this is consistent per application.
Response
boolean
required
Whether or not the request was successful. Always
true for 2xx responses.string
required
Response message.
string
required
The send’s unique tracking code.
string
The address collection link to share with the recipient. Only returned when
address_confirmation_via is link.{
"send": {
"touch_id": 123456,
"name": "John Smith",
"email": "developers@sendoso.com",
"custom_message": "Hi John, I wanted to personally invite you to...",
"address_confirmation_via": "email",
"expire_after_days": 5,
"address_confirmation_custom_message": "Please update your shipping address!",
"hide_product_info": true,
"no_address": true,
"confirm_address": true,
"resume_with_unconfirmed_address": false,
"via": "single_person_or_company",
"via_from": "YOUR APPLICATION NAME"
}
}
{
"success": true,
"message": "Gift send Successfully",
"tracking_code": "116d64dc686937dd17b1865019cee71d295bcf38"
}
{
"success": false,
"message": "email can't be blank"
}
{
"success": false,
"message": "The access token is invalid"
}
{
"success": false,
"message": "Touch not found"
}
⌘I
{
"send": {
"touch_id": 123456,
"name": "John Smith",
"email": "developers@sendoso.com",
"custom_message": "Hi John, I wanted to personally invite you to...",
"address_confirmation_via": "email",
"expire_after_days": 5,
"address_confirmation_custom_message": "Please update your shipping address!",
"hide_product_info": true,
"no_address": true,
"confirm_address": true,
"resume_with_unconfirmed_address": false,
"via": "single_person_or_company",
"via_from": "YOUR APPLICATION NAME"
}
}
{
"success": true,
"message": "Gift send Successfully",
"tracking_code": "116d64dc686937dd17b1865019cee71d295bcf38"
}
{
"success": false,
"message": "email can't be blank"
}
{
"success": false,
"message": "The access token is invalid"
}
{
"success": false,
"message": "Touch not found"
}