Sendoso · JSON Structure
Sendoso Send Structure
Field-by-field structural documentation for the Sendoso Send resource
Type:
Properties: 0
Corporate GiftingDirect MailSales EngagementMarketing AutomationCRM Integration
Sendoso Send Structure is a JSON Structure definition published by Sendoso.
Meta-schema:
JSON Structure
{
"title": "Sendoso Send Structure",
"description": "Field-by-field structural documentation for the Sendoso Send resource",
"version": "2.0",
"source": "https://developer.sendoso.com/reference",
"fields": [
{
"name": "id",
"type": "string",
"required": true,
"description": "Unique send identifier"
},
{
"name": "status",
"type": "string",
"required": true,
"enum": ["pending", "processing", "shipped", "delivered", "failed", "cancelled"],
"description": "Lifecycle status. pending → processing → shipped → delivered. Cancellation only possible in pending state."
},
{
"name": "recipient",
"type": "object",
"required": true,
"description": "Abbreviated recipient contact reference",
"fields": [
{"name": "id", "type": "string", "required": true},
{"name": "first_name", "type": "string", "required": true},
{"name": "last_name", "type": "string", "required": true},
{"name": "email", "type": "string", "format": "email"}
]
},
{
"name": "item",
"type": "object",
"required": true,
"description": "The inventory item being sent",
"fields": [
{"name": "id", "type": "string", "required": true},
{"name": "name", "type": "string", "required": true},
{"name": "type", "type": "string", "enum": ["physical", "egift", "swag", "direct_mail", "charity"]}
]
},
{
"name": "message",
"type": "string",
"maxLength": 500,
"description": "Personalized gift message included with the send"
},
{
"name": "tracking_number",
"type": "string",
"nullable": true,
"description": "Carrier tracking number. Null until item ships."
},
{
"name": "tracking_url",
"type": "string",
"format": "uri",
"nullable": true,
"description": "Direct link to carrier tracking page"
},
{
"name": "estimated_delivery",
"type": "string",
"format": "date",
"nullable": true,
"description": "Estimated delivery date in YYYY-MM-DD format"
},
{
"name": "cost",
"type": "number",
"format": "float",
"description": "Total cost in USD including item price and shipping"
},
{
"name": "crm_id",
"type": "string",
"nullable": true,
"description": "External CRM object ID for attribution (Salesforce, HubSpot, etc.)"
},
{
"name": "crm_type",
"type": "string",
"nullable": true,
"enum": ["contact", "lead", "account", "opportunity"],
"description": "CRM object type for the associated crm_id"
},
{
"name": "team_id",
"type": "string",
"required": true,
"description": "The Sendoso team that owns and is billed for this send"
},
{
"name": "created_at",
"type": "string",
"format": "date-time",
"required": true,
"description": "ISO 8601 timestamp when the send was initiated"
},
{
"name": "updated_at",
"type": "string",
"format": "date-time",
"description": "ISO 8601 timestamp of the last status change"
}
]
}