Delete a recipient

In this section, you will learn how you can remove a recipient from a job.

Important

All operations related to the recipient can be done in a job only before checkout, no operations are permitted once the job Checkout is done.

For more info about the checkout of a job click here

URL Config

Method: GET
Endpoint: https://api.dps.io/api 
APIVersion: v1
route: jobs
path: recipients/<YOUR_JOB_HASH>/<RECIPIENT_HASH>

Method

DELETE

URL

https://api.dps.io/api/v1/jobs/recipients/G*************************n1CA

Request Headers

{
  "x-api-key": "<YOUR_API_KEY>",
  "ShipperHash": "<YOUR_SHIPPER_HASH>"
}

Curl request

curl --location --request DELETE 'https://api.dps.io/api/v1/jobs/recipients/Gdd*********************JbEn1CA' \
--header 'x-api-key: xxxxxxdfjbdjdfjdhfxxxxxxx' \
--header 'ShipperHash: 05K9****************************BJG6a'

Response

{
    "data": "Recipient of RecipientHash : HrBEIP*******************n1CA has successfully deleted"
}