Skip to main content

Map Job Recipient

Mapping a recipient to a job​

In this section, you will learn about the mapping of a recipient with a Job.

Recipients are the receiver of the ePostage . Once you have created the job and got the JobHash, you can now map the recipient to your job.

Important

Before mapping a recipient to a job please make sure you have added or mapped an address to the recipient. For more info click here

URL Config
Method: POST
Endpoint: https://api.dps.io/api
APIVersion: v1
route: jobs
path: recipients
Method
POST
URL
https://api.dps.io/api/v1/jobs/recipients
Request Headers
{
  "Content-Type": "application/json",
  "x-api-key": "<YOUR_API_KEY>",
  "ShipperHash": "<YOUR_SHIPPER_HASH>"
}
Request Body
{
    "JobHash": "Gdds***************8MEMo",
    "AddressId": "180"
}
Curl request
curl --location --request POST 'https://api.dps.io/api/v1/jobs/recipients' \
--header 'x-api-key: xxxxxxdfjbdjdfjdhfxxxxxxx' \
--header 'ShipperHash: 05K9****************************JG6a' \
--header 'Content-Type: application/json' \
--data-raw '{
    "JobHash": "Gdds***************8MEMo",
    "AddressId": "180"
}'
Response Body
{
    "data": {
        "JobHash": "Gdds***************8MEMo",
        "RecipientHash": "HrBE*************En1CA"
    }
}