Getting Started
API Reference
- Users
- Teams
- Campaigns (Touches)
- Sends
Get Campaign
Retrieve additional details on a specific campaign.
curl --request GET \
--url https://app.staging.sendo.so/api/v3/touches/{touch_id} \
--header 'Authorization: Bearer <token>'{
"success": true,
"touch": {
"id": 123456,
"name": "Sendoso Gift",
"start_date": "2023-10-25T00:00:00.000-07:00",
"end_date": null,
"description": "",
"created_at": "2023-10-25T05:21:59.000-07:00",
"user_id": 78901,
"gift_id": 39,
"starting_egift_price": null,
"ending_egift_price": null,
"status": "Active",
"is_default_price": true,
"delivery_type": "mail",
"hubspot_key": null,
"ship_to_countries": ["US", "ES", "CA"],
"currency": "USD"
}
}
Parameters
The campaign identifier.
Response
Whether or not the request was successful. Always true for 200 response.
The campaign’s identifier.
The campaign’s name.
The campaign’s start date (in ISO 8601 format). Gifts cannot be sent for this campaign before this start date.
The campaign’s end date (in ISO 8601 format). Gifts cannot be sent for this campaign after this end date.
The campaign’s description.
The campaign’s creation date (in ISO 8601 format).
The identifier of the user that created this campaign.
The campaign’s general gift identifier.
The campaign’s starting_egift_price and ending_egift_price represent the range amount from which the sender can pick the egift denominiation to send. Only present for eGift campaigns. When this range is present, is_default_price will be false.
The campaign’s starting_egift_price and ending_egift_price represent the range amount from which the sender can pick the egift denominiation to send. Only present for eGift campaigns. When this range is present, is_default_price will be false.
The campaign’s status. It will ALWAYS be Active since this endpoint only returns active campaigns.
Whether or not the sender can pick the eGift amount from a range or if it is a set price.
The type of gift that is associated to this campaign. Valid options are mail which means physical item or email which means eGift.
The campaign’s key to be used for HubSpot integration.
List of countries that this campaign’s gift(s) can be sent to (in ISO 3166-1 alpha-2 format).
The campaign’s gift currency (in ISO 4217 format).
curl --request GET \
--url https://app.staging.sendo.so/api/v3/touches/{touch_id} \
--header 'Authorization: Bearer <token>'{
"success": true,
"touch": {
"id": 123456,
"name": "Sendoso Gift",
"start_date": "2023-10-25T00:00:00.000-07:00",
"end_date": null,
"description": "",
"created_at": "2023-10-25T05:21:59.000-07:00",
"user_id": 78901,
"gift_id": 39,
"starting_egift_price": null,
"ending_egift_price": null,
"status": "Active",
"is_default_price": true,
"delivery_type": "mail",
"hubspot_key": null,
"ship_to_countries": ["US", "ES", "CA"],
"currency": "USD"
}
}