CoworkerDeliveries
Create CoworkerDelivery
Create a new CoworkerDelivery record.
POST
A CoworkerDelivery tracks a delivery (mail, parcel, check, or other item) received on behalf of a customer at a location, along with its current processing status and the customer’s handling preference.
Each delivery records who it is for (
Deliveries can also have attached files — for example, a scanned copy of the contents (
CoworkerId or ContractContactId), what it is (DeliveryType), and how the customer wants it handled (HandlingPreference). Staff can then mark the delivery through its lifecycle — processed, collected, forwarded, scanned, recycled, shredded, or returned to sender — with corresponding timestamps.
Handling preferences control what happens to the delivery:
| HandlingPreference | Meaning |
|---|---|
| StoreForCollection | Hold for the customer to pick up |
| Forward | Forward to the customer’s address |
| OpenScanForward | Open, scan contents, then forward the original |
| OpenScanRecycle | Open, scan contents, then recycle the original |
| OpenScanShred | Open, scan contents, then shred the original |
| OpenScanStoreForCollection | Open, scan contents, then hold for collection |
| Recycle | Recycle the delivery |
| ReturnToSender | Return the delivery to the sender |
| Shred | Shred the delivery |
| DepositCheck | Deposit the enclosed check |
NewScannedFileDataUrl), a forwarding receipt (NewForwardedFileDataUrl), or a collection signature (NewSignatureUrl).
Authentication
This endpoint requires OAuth2 authentication. Include a valid bearer token in the
Authorization header.
The authenticated user must be a full unrestricted administrator or have the CoworkerDelivery-Create role.Enums
eDeliveryType — DeliveryType values
eDeliveryType — DeliveryType values
| Value | Name |
|---|---|
| 0 | None |
| 1 | |
| 2 | Parcel |
| 3 | Check |
| 4 | Publicity |
| 5 | Other |
eDeliveryHandlingPreference
eDeliveryHandlingPreference
| Value | Name |
|---|---|
| 0 | None |
| 1 | StoreForCollection |
| 2 | Forward |
| 3 | OpenScanForward |
| 4 | OpenScanRecycle |
| 5 | OpenScanShred |
| 6 | OpenScanStoreForCollection |
| 7 | Recycle |
| 8 | ReturnToSender |
| 9 | Shred |
| 10 | DepositCheck |
| 11 | Unknown |
Request Body
Required Fields
Business Id.
Short label or description identifying the delivery item.
Physical location where the delivery is being stored (e.g. mailroom shelf).
Optional Fields
Coworker Id.
Contract Contact Id.
Name of the staff member who received the delivery.
Free-text notes about the delivery.
New File Data Url.
Clear File Data File.
New Signature Url.
Clear Signature File.
New Scanned File Data Url.
Clear Scanned File Data File.
New Forwarded File Data Url.
Clear Forwarded File Data File.
Whether the customer has collected the delivery.
Whether the customer must sign upon collection.
Whether the customer has signed for the delivery.
Notified.
Date and time the customer collected the delivery.
Billed.
Type of delivery item (Mail, Parcel, Check, Publicity, or Other). Defaults to
eDeliveryType.Other. See eDeliveryType enum above.How the customer wants this delivery handled (e.g. StoreForCollection, Forward, Shred). See
eDeliveryHandlingPreference? enum above.Whether the enclosed check has been deposited.
Whether the delivery has been forwarded to the customer.
Whether the delivery contents have been scanned.
Whether the delivery has been recycled.
Whether the delivery has been shredded.
Whether the delivery is being held for customer collection.
Whether the delivery has been returned to sender.
Date and time the check was deposited.
Date and time the delivery was forwarded.
Date and time the delivery contents were scanned.
Date and time the delivery was recycled.
Date and time the delivery was shredded.
Date and time the delivery was placed in storage for collection.
Date and time the delivery was returned to sender.
Forwarding Address Unique Id.
Check Deposited Product Unique Id.
Forwarded Product Unique Id.
Scanned Product Unique Id.
Recycled Product Unique Id.
Shredded Product Unique Id.
Stored For Collection Product Unique Id.
Returned To Sender Product Unique Id.
Collected Product Unique Id.
Code Examples
Response
200
HTTP status code.
200 on success.A human-readable message confirming the creation.
Contains the
Id of the newly created record.true if the coworkerdelivery was created successfully.null on success.Example Response
400
A summary of the validation error(s), in the format
PropertyName: error message.null on validation failure.Array of validation errors.
false when the request fails validation.Example Response