Update Inbound Site

This operation used to update Inbound Site.

SecuritybearerAuth
Request
path Parameters
inboundSiteId
required
string
Example: gJVQ5bQW2OVd
Request Body schema: application/json
name
required
string

The name of the inbound site to be updated.

type
required
string

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

locationId
required
string

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

inboundSiteId
string

The unique identifier of the inbound site to be updated.

status
required
string

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

defaultSite
required
boolean

Indicates whether this is the default inbound site.

parent
string

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.

Responses
200

Requested Inbound Site has been updated successfully.

400

Invalid request.

401

The request could not be authorized.

500

The request could not be completed due to an internal error.

put/api/v1/inboundsites/{inboundSiteId}
Request samples
application/json
{
  • "name": "Site A",
  • "type": "site",
  • "locationId": "loc123",
  • "inboundSiteId": "INB123",
  • "status": "Active",
  • "defaultSite": true,
  • "parent": "GNgzzLNQ9zBb"
}
Response samples
application/json
{
  • "errors": [
    ]
}