Skip to content

Update Inbound Site

Request

This operation used to update Inbound Site.

Security
bearerAuth
Path
inboundSiteIdstringrequired
Example:gJVQ5bQW2OVd
Bodyapplication/jsonrequired
namestringrequired

The name of the inbound site to be updated.

Example:"Site A"
typestringrequired

The type of the inbound site, such as Site, Building etc.

Example:"site"
locationIdstringrequired

The unique identifier of the location associated with the inbound site.

Example:"loc123"
inboundSiteIdstring

The unique identifier of the inbound site to be updated.

Example:"INB123"
statusstringrequired

The current status of the inbound site, such as Active or Inactive.

Example:"Active"
defaultSitebooleanrequired

Indicates whether this is the default inbound site.

Example:true
parentstring

This is the inboundSiteId of parent to which this type should belongs to, for example in case of type building, Site is the parent. In case of updating Building, Floor, floor or Mailstop, user must pass its parent inbound site serviceID.

Example:"GNgzzLNQ9zBb"
curl -i -X PUT \
  https://api-sandbox.sendpro360.pitneybowes.com/pitneytrack/api/v1/inboundsites/gJVQ5bQW2OVd \
  -H 'Authorization: Bearer <YOUR_TOKEN_HERE>' \
  -H 'Content-Type: application/json' \
  -d '{
    "name": "Site A",
    "type": "site",
    "locationId": "loc123",
    "inboundSiteId": "INB123",
    "status": "Active",
    "defaultSite": true,
    "parent": "GNgzzLNQ9zBb"
  }'

Responses

Requested Inbound Site has been updated successfully.

Bodyapplication/json
Response
No content