7x Developer Portal & API Documentation

Removes an existing link between the user and a PO Box using unique box identity. Used when delegated access or linked-box relationships should be revoked.

Request builder

POST

/api/v1/PoBoxes/UnLinkPoBox

Access Token

api-versionstring

*object

requestSourcestring

uniqueBoxId*string

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/PoBoxes/UnLinkPoBox" \  -H "Content-Type: application/json" \  -d '{    "uniqueBoxId": "string"  }'

{  "message": "string",  "payload": {    "referenceCode": "string"  },  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "message": "string",  "payload": null,  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

Overview

Removes an existing link between the user and a PO Box using unique box identity. Used when delegated access or linked-box relationships should be revoked.

Request builder

POST

/api/v1/PoBoxes/UnLinkPoBox

Access Token

api-versionstring

*object

requestSourcestring

uniqueBoxId*string

Reference details

Authorization

OAuth2

AuthorizationBearer <token>

In: header

Query Parameters

api-version?string

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

requestSource?Source

Value in

"Web"
"Mobile"

uniqueBoxId*string

Length3 <= length

Response Body

`application/json`

curl -X POST "https://example.com/api/v1/PoBoxes/UnLinkPoBox" \  -H "Content-Type: application/json" \  -d '{    "uniqueBoxId": "string"  }'

{  "message": "string",  "payload": {    "referenceCode": "string"  },  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "message": "string",  "payload": null,  "responseCode": "Continue",  "errorDetails": {    "property1": null,    "property2": null  }}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

{  "type": "string",  "title": "string",  "status": 0,  "detail": "string",  "instance": "string",  "property1": null,  "property2": null}

requestSource?Source

Value in

"Web"
"Mobile"

uniqueBoxId*string

Length3 <= length

200application/json

400application/json

404application/json

500application/json

200application/json

400application/json

404application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`