Getting Started
API Reference
- Users
- Teams
- Campaigns (Touches)
- Sends
- GETRetrieve All Sends
- Create Send
- Physical Gifts
- eGifts
- GET
Send Physical Gift with Address Collection
This endpoint allows you to send a physical item when you do not know the recipient address.
{
"send":
{
"touch_id": 123456,
"name": "John Smith",
"email": "developers@sendoso.com",
"custom_message": "Hi John, I wanted to personally invite you to...",
"no_address": true,
"confirm_address": true,
"address_confirmation_via": "email",
"resume_with_unconfirmed_address": false,
"expire_after_days": 5,
"hide_product_info": true,
"address_confirmation_custom_message": "Please update your shipping address!",
"via": "single_person_or_company",
"via_from": "YOUR APPLICATION NAME"
}
}
{
"success": true,
"message": "Gift send Successfully",
"tracking_code": "116d64dc686937dd17b1865019cee71d295bcf38"
}
Body
The ID of the campaign within Sendoso you are wanting to send.
The recipient’s name
The recipient’s email address.
The message that goes on the notecard in the gift box (if applicable).
Indicates whether the recipient’s address is provided in the payload or not. Value must be true.
Indicates if you are sending the address collection email. Value must be true.
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.
Whether or not the gift should be sent if the user does NOT confirm their address. For this endpoint, please leave as FALSE.
Sets the number of days the address collection form will be valid. Valid values are from 2 to 7 inclusive.
Determines whether or not the gift name & image will appear on the address collection page.
The message that is on the address collection email. Note - this is only applicable if you are sending the address collectionn via the email method.
Value must be single_person_or_company.
The name of the application making the send request. Please make sure this is consistent per application.
Response
Whether or not the request was successful. Always true for 2xx responses.
Response message.
The send’s unique tracking code.
{
"send":
{
"touch_id": 123456,
"name": "John Smith",
"email": "developers@sendoso.com",
"custom_message": "Hi John, I wanted to personally invite you to...",
"no_address": true,
"confirm_address": true,
"address_confirmation_via": "email",
"resume_with_unconfirmed_address": false,
"expire_after_days": 5,
"hide_product_info": true,
"address_confirmation_custom_message": "Please update your shipping address!",
"via": "single_person_or_company",
"via_from": "YOUR APPLICATION NAME"
}
}
{
"success": true,
"message": "Gift send Successfully",
"tracking_code": "116d64dc686937dd17b1865019cee71d295bcf38"
}
{
"send":
{
"touch_id": 123456,
"name": "John Smith",
"email": "developers@sendoso.com",
"custom_message": "Hi John, I wanted to personally invite you to...",
"no_address": true,
"confirm_address": true,
"address_confirmation_via": "email",
"resume_with_unconfirmed_address": false,
"expire_after_days": 5,
"hide_product_info": true,
"address_confirmation_custom_message": "Please update your shipping address!",
"via": "single_person_or_company",
"via_from": "YOUR APPLICATION NAME"
}
}
{
"success": true,
"message": "Gift send Successfully",
"tracking_code": "116d64dc686937dd17b1865019cee71d295bcf38"
}