CoworkerDeliveries
Update CoworkerDelivery
Update an existing CoworkerDelivery record.
PUT
Update CoworkerDelivery
Updates an existing CoworkerDelivery record. You must include the
Id of the record to update along with all required fields.
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-Edit role.Enums
eDeliveryType — DeliveryType values
eDeliveryType — DeliveryType values
eDeliveryHandlingPreference
eDeliveryHandlingPreference
Request Body
Required Fields
integer
required
The Id of the CoworkerDelivery record to update.
integer
required
ID of the location that owns this delivery. Defaults to the current location when creating a delivery..
string
required
Required short reference that identifies the delivery item..
string
required
Required physical storage location for the delivery, such as a mailroom shelf..
integer
required
Type of delivery item: Mail, Parcel, Check, Publicity, or Other. It selects the default handling preference for virtual-office customers..
Optional Fields
integer
ID of the customer this delivery is for. Use either CoworkerId or ContractContactId to identify the recipient..
integer
ID of the contract contact receiving this delivery when it is not assigned to a customer..
string
Name of the staff member who received the delivery..
string
Free-text operational notes about the delivery..
string
URL of a new file to upload as the file data.
boolean
Set to true to remove the current file data file.
string
URL of a new file to upload as the signature.
boolean
Set to true to remove the current signature file.
string
URL of a new file to upload as the scanned file data.
boolean
Set to true to remove the current scanned file data file.
string
URL of a new file to upload as the forwarded file data.
boolean
Set to true to remove the current forwarded file data file.
boolean
Whether the customer has collected the delivery; set CollectedOn when recording collection..
boolean
Whether the customer must provide a signature when collecting the delivery..
boolean
Whether the customer has signed for the delivery; attach the signature through NewSignatureUrl when available..
boolean
Whether the system sent the delivery-received notification; maintained by delivery notification handlers..
string
Date and time the customer collected the delivery; record it when marking Collected as true..
boolean
Whether charges for delivery handling have been billed; maintained by the delivery processing workflow..
integer
Virtual-office delivery workflow: StoreForCollection, Forward, OpenScanForward, OpenScanRecycle, OpenScanShred, OpenScanStoreForCollection, Recycle, ReturnToSender, Shred, DepositCheck, or Unknown. It is not relevant for customers without a virtual-office contract; for virtual-office customers it defaults from the active contract by delivery type, falling back to StoreForCollection.. See
eDeliveryHandlingPreference? enum above.boolean
For a virtual-office DepositCheck workflow, whether the enclosed check has been deposited; record CheckDepositedOn when marking it complete..
boolean
For a virtual-office forwarding workflow, whether the delivery has been forwarded to the customer; record ForwardedOn when marking it complete..
boolean
For a virtual-office open-and-scan workflow, whether the delivery contents have been scanned; record ScannedOn when marking it complete..
boolean
For a virtual-office recycling workflow, whether the delivery has been recycled; record RecycledOn when marking it complete..
boolean
For a virtual-office shredding workflow, whether the delivery has been shredded; record ShreddedOn when marking it complete..
boolean
For a virtual-office collection workflow, whether the delivery has been stored for customer collection; record StoredForCollectionOn when marking it complete..
boolean
For a virtual-office return workflow, whether the delivery has been returned to the sender; record ReturnedToSenderOn when marking it complete..
string
For a virtual-office DepositCheck workflow, date and time the check was deposited, recorded with CheckDeposited..
string
For a virtual-office forwarding workflow, date and time the delivery was forwarded, recorded with Forwarded..
string
For a virtual-office open-and-scan workflow, date and time the delivery contents were scanned, recorded with Scanned..
string
For a virtual-office recycling workflow, date and time the delivery was recycled, recorded with Recycled..
string
For a virtual-office shredding workflow, date and time the delivery was shredded, recorded with Shredded..
string
For a virtual-office collection workflow, date and time the delivery was placed in storage for collection, recorded with StoredForCollection..
string
For a virtual-office return workflow, date and time the delivery was returned to the sender, recorded with ReturnedToSender..
string
Unique ID of the nominated forwarding address; defaults from the virtual-office contract and is managed by the delivery workflow..
string
Unique ID of the product charge created for depositing a check; managed by the delivery workflow..
string
Unique ID of the product charge created for forwarding; managed by the delivery workflow..
string
Unique ID of the product charge created for scanning; managed by the delivery workflow..
string
Unique ID of the product charge created for recycling; managed by the delivery workflow..
string
Unique ID of the product charge created for shredding; managed by the delivery workflow..
string
Unique ID of the product charge created for storage for collection; managed by the delivery workflow..
string
Unique ID of the product charge created for returning to sender; managed by the delivery workflow..
string
Unique ID of the product charge created for collection; managed by the delivery workflow..
Code Examples
Response
200
integer
HTTP status code.
200 on success.string
A human-readable message confirming the update.
object
Contains the
Id of the updated record.boolean
true if the coworkerdelivery was updated successfully.array
null on success.Example Response
400
string
A summary of the validation error(s), in the format
PropertyName: error message.any
null on validation failure.object[]
Array of validation errors.
boolean
false when the request fails validation.Example Response