{
"opencollection": "1.0.0",
"info": {
"name": "Openpath API Documentation auth orgs/mailrooms API",
"version": "1.0.0"
},
"items": [
{
"info": {
"name": "orgs/mailrooms",
"type": "folder"
},
"items": [
{
"info": {
"name": "List active mailrooms",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/mailrooms",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "limit",
"value": "",
"type": "query"
},
{
"name": "offset",
"value": "",
"type": "query"
},
{
"name": "sort",
"value": "",
"type": "query"
},
{
"name": "order",
"value": "",
"type": "query"
},
{
"name": "q",
"value": "",
"type": "query"
},
{
"name": "filter",
"value": "",
"type": "query"
},
{
"name": "preFilter",
"value": "",
"type": "query"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w
__Endpoint name__: listMailrooms"
},
{
"info": {
"name": "Create a mailroom",
"type": "http"
},
"http": {
"method": "POST",
"url": "{{baseUrl}}/orgs/:orgId/mailrooms",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w
__Endpoint name__: createMailroom"
},
{
"info": {
"name": "Describe a mailroom",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/mailrooms/:mailroomId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "mailroomId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w
__Endpoint name__: describeMailroom"
},
{
"info": {
"name": "Update a mailroom",
"type": "http"
},
"http": {
"method": "PATCH",
"url": "{{baseUrl}}/orgs/:orgId/mailrooms/:mailroomId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "mailroomId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w
__Endpoint name__: updateMailroom"
},
{
"info": {
"name": "Delete a mailroom",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/mailrooms/:mailroomId",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "mailroomId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:w,o:w,s-o:w
__Endpoint name__: deleteMailroom"
},
{
"info": {
"name": "Get all mailroom statistics",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/mailrooms/statistics",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w
__Endpoint name__: describeAllMailroomStatistics"
},
{
"info": {
"name": "Get single mailroom statistics",
"type": "http"
},
"http": {
"method": "GET",
"url": "{{baseUrl}}/orgs/:orgId/mailrooms/:mailroomId/statistics",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
},
{
"name": "mailroomId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-parcelMgmtParcels:r,o{params.orgId}-parcelMgmtParcels:w,o:w,o:r,s-o:r,s-o:w
__Endpoint name__: describeMailroomStatistics"
},
{
"info": {
"name": "Cancel mailroom",
"type": "http"
},
"http": {
"method": "DELETE",
"url": "{{baseUrl}}/orgs/:orgId/mailrooms/cancel",
"params": [
{
"name": "orgId",
"value": "",
"type": "path"
}
]
},
"docs": "__JWT is required for this endpoint with at least one of the following scopes__: o{params.orgId}-admin:w,o:w,s-o:w
__Endpoint name__: cancelMailroom"
}
]
}
],
"bundled": true
}