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...",
            "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

send
object
required
touch_id
integer
required

The ID of the campaign within Sendoso you are wanting to send.

name
string
required

The recipient’s name

email
string
required

The recipient’s email address.

custom_message
string

The message that goes on the notecard in the gift box (if applicable).

no_address
boolean
required

Indicates whether the recipient’s address is provided in the payload or not. Value must be true.

confirm_address
boolean
required

Indicates if you are sending the address collection email. Value must be true.

address_confirmation_via
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.

resume_with_unconfirmed_address
boolean
required

Whether or not the gift should be sent if the user does NOT confirm their address. For this endpoint, please leave as FALSE.

expire_after_days
integer
required

Sets the number of days the address collection form will be valid. Valid values are from 2 to 7 inclusive.

hide_product_info
boolean
required

Determines whether or not the gift name & image will appear on the address collection page.

address_confirmation_custom_message
string

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.

via
string
required

Value must be single_person_or_company.

via_from
string
required

The name of the application making the send request. Please make sure this is consistent per application.

Response

success
boolean
required

Whether or not the request was successful. Always true for 2xx responses.

message
string
required

Response message.

tracking_code
string
required

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"
}