Create CoworkerDelivery - Nexudus Platform

POST

api

spaces

coworkerdeliveries

Create CoworkerDelivery

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/coworkerdeliveries \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Location": "<string>",
  "DeliveryType": 123
}
'

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

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 (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

Deliveries can also have attached files — for example, a scanned copy of the contents (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

Value	Name
0	None
1	Mail
2	Parcel
3	Check
4	Publicity
5	Other

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

BusinessId

integer

required

ID of the business linked to this record.

Name

string

required

Short label or description identifying the delivery item.

Location

string

required

Physical location where the delivery is being stored (e.g. mailroom shelf).

DeliveryType

integer

required

Type of delivery item (Mail, Parcel, Check, Publicity, or Other). Defaults to eDeliveryType.Other.

Optional Fields

CoworkerId

integer

ID of the coworker linked to this record.

ContractContactId

integer

ID of the contract contact linked to this record.

ReceivedBy

string

Name of the staff member who received the delivery.

Notes

string

Free-text notes about the delivery.

NewFileDataUrl

string

URL of a new file to upload as the file data.

ClearFileDataFile

boolean

Set to true to remove the current file data file.

NewSignatureUrl

string

URL of a new file to upload as the signature.

ClearSignatureFile

boolean

Set to true to remove the current signature file.

NewScannedFileDataUrl

string

URL of a new file to upload as the scanned file data.

ClearScannedFileDataFile

boolean

Set to true to remove the current scanned file data file.

NewForwardedFileDataUrl

string

URL of a new file to upload as the forwarded file data.

ClearForwardedFileDataFile

boolean

Set to true to remove the current forwarded file data file.

Collected

boolean

Whether the customer has collected the delivery.

RequiresSignature

boolean

Whether the customer must sign upon collection.

Signed

boolean

Whether the customer has signed for the delivery.

Notified

boolean

Whether notified is enabled.

CollectedOn

string

Date and time the customer collected the delivery.

Billed

boolean

Whether billed is enabled.

HandlingPreference

integer

How the customer wants this delivery handled (e.g. StoreForCollection, Forward, Shred). See eDeliveryHandlingPreference? enum above.

CheckDeposited

boolean

Whether the enclosed check has been deposited.

Forwarded

boolean

Whether the delivery has been forwarded to the customer.

Scanned

boolean

Whether the delivery contents have been scanned.

Recycled

boolean

Whether the delivery has been recycled.

Shredded

boolean

Whether the delivery has been shredded.

StoredForCollection

boolean

Whether the delivery is being held for customer collection.

ReturnedToSender

boolean

Whether the delivery has been returned to sender.

CheckDepositedOn

string

Date and time the check was deposited.

ForwardedOn

string

Date and time the delivery was forwarded.

ScannedOn

string

Date and time the delivery contents were scanned.

RecycledOn

string

Date and time the delivery was recycled.

ShreddedOn

string

Date and time the delivery was shredded.

StoredForCollectionOn

string

Date and time the delivery was placed in storage for collection.

ReturnedToSenderOn

string

Date and time the delivery was returned to sender.

ForwardingAddressUniqueId

string

ID of the forwarding address unique associated with this record.

CheckDepositedProductUniqueId

string

ID of the check deposited product unique associated with this record.

ForwardedProductUniqueId

string

ID of the forwarded product unique associated with this record.

ScannedProductUniqueId

string

ID of the scanned product unique associated with this record.

RecycledProductUniqueId

string

ID of the recycled product unique associated with this record.

ShreddedProductUniqueId

string

ID of the shredded product unique associated with this record.

StoredForCollectionProductUniqueId

string

ID of the stored for collection product unique associated with this record.

ReturnedToSenderProductUniqueId

string

ID of the returned to sender product unique associated with this record.

CollectedProductUniqueId

string

ID of the collected product unique associated with this record.

Code Examples

curl -X POST \
  "https://spaces.nexudus.com/api/spaces/coworkerdeliveries" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
    "BusinessId": 0,
    "Name": "",
    "Location": "",
    "DeliveryType": 0
}'

Response

200

Status

integer

HTTP status code. 200 on success.

Message

string

A human-readable message confirming the creation.

Value

object

Contains the Id of the newly created record.

WasSuccessful

boolean

true if the coworkerdelivery was created successfully.

Errors

array

null on success.

Example Response

{
  "Status": 200,
  "Message": "CoworkerDelivery was successfully created.",
  "Value": {
    "Id": 87654321
  },
  "OpenInDialog": false,
  "OpenInWindow": false,
  "RedirectURL": null,
  "JavaScript": null,
  "UpdatedOn": "2025-01-15T10:30:00Z",
  "UpdatedBy": "admin@example.com",
  "Errors": null,
  "WasSuccessful": true
}

400

Message

string

A summary of the validation error(s), in the format PropertyName: error message.

Value

any

null on validation failure.

Errors

object[]

Array of validation errors.

Show child attributes

AttemptedValue

any

The value that was submitted for the field, or null if missing.

Message

string

The validation error message.

PropertyName

string

The name of the property that failed validation.

WasSuccessful

boolean

false when the request fails validation.

Example Response

{
  "Message": "Name: is a required field",
  "Value": null,
  "Errors": [
    {
      "AttemptedValue": null,
      "Message": "is a required field",
      "PropertyName": "Name"
    }
  ],
  "WasSuccessful": false
}

Update CoworkerDeliveryUpdate an existing CoworkerDelivery record.

Create CoworkerDelivery

curl --request POST \
  --url https://spaces.nexudus.com/api/spaces/coworkerdeliveries \
  --header 'Authorization: Basic <encoded-value>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "BusinessId": 123,
  "Name": "<string>",
  "Location": "<string>",
  "DeliveryType": 123
}
'

{
  "Status": 123,
  "Message": "<string>",
  "Value": "<any>",
  "WasSuccessful": true,
  "Errors": [
    {
      "AttemptedValue": "<any>",
      "Message": "<string>",
      "PropertyName": "<string>"
    }
  ]
}

​Authentication

​Enums

​Request Body

​Required Fields

​Optional Fields

​Code Examples

​Response

​200

​400

Authentication

Enums

Request Body

Required Fields

Optional Fields

Code Examples

Response

200

400