agent_notesstring
Инструкции для оператора объекта (например, "Срочно - отправить сегодня").
colorboolean
Цветные страницы по умолчанию стоят $0.70 за страницу суммарно, до обработки и почтовых расходов: $0.40 за страницу - базовая чёрно-белая печать плюс $0.30 за страницу - надбавка за цвет. В cost_breakdown поле color_printing_per_page_cents - это полная цена печати цветной страницы (70 центов по умолчанию), а color_surcharge_per_page_cents - только надбавка за цвет (30 центов по умолчанию). Цены для конкретного аккаунта могут переопределять эти значения по умолчанию; cost_breakdown имеет приоритет.
document_base64stringобязательный
Файл документа в кодировке Base64. Поддерживаемые форматы: PDF, DOCX, JPG, PNG, TXT, CSV. Максимум 10 МБ после декодирования.
document_filenamestring
Исходное имя файла с расширением (например, "letter.docx"). Требуется для надёжного определения не-PDF формата.
dry_runboolean
Проверяет входные данные и возвращает разбивку стоимости, не создавая запись и не расходуя кредиты. Используйте, чтобы заранее увидеть, сколько кредитов потребуется, перед подтверждением.
duplexboolean
Запрашивает двустороннюю печать, когда это технически возможно. Стоимость и page_count рассчитываются на основе обнаруженного или указанного количества страниц документа; используйте dry_run=true, чтобы предварительно просмотреть точную стоимость.
inbound_capture_idstring
Необязательный входящий почтовый элемент, на который отвечает это исходящее сообщение. Рекомендуется при составлении черновика из контекста OCR/пересланного письма.
mailbox_md_versionnumberобязательный
Ваша текущая версия MAILBOX.md (из get_mailbox_md). Требуется для проверки синхронизации.
mail_classenum
Почтовый или курьерский сервис. Не выводите скорость, отслеживание или подтверждение из маркетинговых названий перевозчика. Используйте first_class для обычных самых дешёвых писем USPS без номера отслеживания перевозчика по умолчанию. USPS First-Class Mail имеет опубликованную базовую ставку $2.00 за одну страницу. Дополнительные страницы добавляют настроенную печать плюс любое увеличение почтового тарифа от веса. Если обычная формула первой страницы для аккаунта ниже, cost_breakdown.first_class_baseline_adjustment_cents выделяет разницу отдельно от почтового тарифа перевозчика. Используйте priority для более быстрой USPS Priority Mail с USPS Tracking, но без подтверждения Certified Mail; priority имеет опубликованный минимум $15.00 за одну страницу. Используйте certified для отслеживания USPS плюс подтверждения отправки/доставки; certified имеет опубликованный минимум $20.00 за одну страницу. Используйте certified_return_receipt, когда требуется электронное подтверждение получения; certified_return_receipt имеет опубликованный минимум $24.00 за одну страницу. Используйте fedex_ground или ups_ground для бюджетного отслеживания у частного перевозчика; fedex_express означает FedEx Express Saver/третий рабочий день, fedex_2day и ups_2day означают второй рабочий день, а fedex_overnight или ups_next_day означают следующий рабочий день. Классы экспресс-доставки FedEx используют базовую ставку документа Standard List из настроенного пункта отправки, если только FedEx One Rate не настроен явно в операционном режиме; fedex_2day затем применяет фиксированное снижение цены для клиента на $8.00 (service_adjustment_cents: -800), а fedex_overnight сохраняет фиксированную надбавку к цене для клиента $18.00 (service_adjustment_cents: 1800). Одни и те же тарифы печати применяются к каждому mail_class. Цветные страницы стоят в сумме $0.70/страница по умолчанию до обработки и почтового тарифа: $0.40/страница за базовую чёрно-белую печать плюс $0.30/страница за добавление цвета. В cost_breakdown color_printing_per_page_cents - это общая цена печати цветной страницы (70 центов по умолчанию), а color_surcharge_per_page_cents - только добавка за апгрейд (30 центов по умолчанию). Цены для конкретного аккаунта могут переопределять эти значения по умолчанию; cost_breakdown имеет приоритет.
max_cost_centsinteger
Лимит стоимости в центах. Если рассчитанная стоимость превышает его, запрос отклоняется с кодом 422 до списания кредитов. Предотвращает случайные дорогие рассылки.
metadataobject
Произвольные пары ключ-значение, которые возвращаются в ответах GET и вебхуках. Рекомендуемое соглашение: { "workflow_id": "wf_123", "reason": "Отмена клиентом", "correlation_id": "abc" }.
package_idstring
Привязывает это письмо к входящему пакету (например, при ответе на полученную корреспонденцию).
page_countnumber
Явное количество страниц для документов не в формате PDF, когда точная пагинация известна. Если указать его для DOCX, TXT или CSV, оно переопределяет локальное определение и делает расчёт цены детерминированным.
postal_mail_thread_idstring
Необязательная цепочка физической почты, к которой привязать это исходящее письмо. Позволяет агентам вести входящую и исходящую активность в одном долговечном рабочем процессе.
recipient_citystringобязательный
Город получателя.
recipient_companystring
Строка компании или организации для получателя. Необязательна, если указан recipient_name.
recipient_countrystring
Код страны по стандарту ISO 3166-1 alpha-2. По умолчанию - "US".
recipient_line1stringобязательный
Строка 1 адреса получателя.
recipient_line2string
Строка адреса 2 (квартира, офис, помещение и т. д.).
recipient_namestring
Имя человека-получателя письма. Необязательно, если указан recipient_company.
recipient_statestringобязательный
Двухбуквенный код штата США (например, CA, NY, TX).
recipient_zipstringобязательный
5-значный или 5+4-значный ZIP-код (например, "90210" или "90210-1234").
requires_approvalboolean
Если true, арендатор должен подтвердить в своём личном кабинете, прежде чем письмо распечатают и отправят.
return_citystring
Возвращает город адреса. Если не указан, по умолчанию берётся из профиля участника.
return_companystring
Необязательная строка компании или организации для обратного адреса.
return_line1string
Возвращает первую строку адреса. Если её не указать, берётся из профиля участника.
return_line2string
Возвращает вторую строку адреса (апартаменты, помещение и т. д.).
return_namestring
Имя обратного адреса. По умолчанию берётся имя профиля участника, если не указано.
return_statestring
Возвращает штат адреса (двухбуквенный код). Если не указан, по умолчанию берётся из профиля участника.
return_zipstring
Возвращает ZIP-код адреса. Если не указан, по умолчанию берётся из профиля участника.