Skip to main content
DELETE
/
api
/
rest
/
carrier_invoices
/
{carrierInvoiceId}
/
documents
/
{id}
Delete Carrier Invoice Document
curl --request DELETE \
  --url https://api.upwell.com/api/rest/carrier_invoices/{carrierInvoiceId}/documents/{id} \
  --header 'Content-Type: application/json' \
  --data '
{
  "carrierInvoiceId": "<string>",
  "id": "<string>"
}
'
{
  "deleteFileAssociations": {
    "affectedRows": 123,
    "returning": [
      {
        "associationId": "<string>",
        "fileId": "<string>",
        "id": "<string>"
      }
    ]
  }
}

Headers

ā€‹
authorization
string

Your API key will be used for authentication of the request. Authorization: YOUR_API_KEY

Path Parameters

ā€‹
id
string
required

"carrierInvoiceId" is required (enter it either in parameters or request body)

ā€‹
carrierInvoiceId
string
required

"id" is required (enter it either in parameters or request body)

Body

application/json

Query parameters can also be provided in the request body as a JSON object

ā€‹
carrierInvoiceId
string
ā€‹
id
string

Response

200 - application/json

Responses for DELETE /api/rest/carrier_invoices/{carrierInvoiceId}/documents/{id}

ā€‹
deleteFileAssociations
FileAssociationsMutationResponse Ā· object

response of any mutation on the table "file_associations"