API Referencesandbox

Seedmail

Authentication

AuthorizationBearer

Your API key, sent as Authorization: Bearer usgmk_live_....

Request

This endpoint expects an object.
sender_namestringOptional1-200 characters
mail_typeenumOptional

Type of the seeded item. LETTER and LARGELETTER accept a SCAN_REQUEST; the rest accept an UNBOXING_REQUEST.

weightdoubleOptional
Item weight, in pounds.
measurementobjectOptional
Item dimensions, in inches.

Response

mail_idstring

Id of the seeded mail item (numeric string).

Errors

400
Bad Request Error
401
Unauthorized Error
403
Forbidden Error
404
Not Found Error
409
Conflict Error
422
Unprocessable Entity Error
429
Too Many Requests Error
500
Internal Server Error