1. Help Center
  2. API documentation

Step 2: Create New Sender

Use this endpoint to create a new sender in the Dispatch system, the response returns sender info with a system-generated sender_id and user_profile_id.

Request Parameters

Parameter

Required?

Type

Description

access_token

Yes

String

Access token generated 

company_slug

Yes

String

Dispatcher company slug

sender_type

Yes

String

Indicate an individual or corporate sender

phone

Yes

String

Sender contact phone

password

Yes

String

Create a sender password

name

Yes

String

Sender’s name

email

Yes

String

Sender’s email address

billing_address

Yes

String

Sender’s billing address

Request Sample cURL/Payload

curl -X POST "https://umbrella.yojee.com/api/v3/dispatcher/senders" -H "accept: application/json" -H "ACCESS_TOKEN: pCVPeEEUuKnM7geUOcSLY2imA5l6YUdjymkApBDAAGY=" -H "COMPANY_SLUG: yojee" -H "content-type: application/json" -d "{ \"sender_type\": \"individual\", \"phone\": \"+6577886633\", \"password\": \"passwd112233\", \"name\": \"Yojee Test Sender\", \"email\": \"yojeetest@yojee.com\", \"billing_address\": \"144 Robinson Road\"}"

Sample Response Body

Server Code Status: 200 => Create Sender response success

example value(s)

{
"data": {
"billing_address": "144 Robinson Road",
"email": "yojeetest@yojee.com",
"id": 864,
"inserted_at": "2019-06-04T03:59:51.277209Z",
"name": "Yojee Test Sender",
"phone": "+6577886633",
"sender_type": "individual",
"user_profile_id": 2392
}
}

If you later need to update the information for one sender, please refer to the following PUT request to update the sender particulars.

Request Parameters

Parameter

Required?

Type

Description

access_token

Yes

String

Access token generated 

company_slug

Yes

String

Dispatcher company slug

sender_id

Yes

String

Sender ID

sender

Yes

Body

Sender details to be updated

Request Sample cURL/Payload

curl -X PUT "https://umbrella.yojee.com/api/v3/dispatcher/senders/864" -H "accept: application/json" -H "ACCESS_TOKEN: 8pCVPeEEUuKnM7geUOcSLY2imA5l6YUdjymkApBDAAGY=" -H "COMPANY_SLUG: yojee" -H "content-type: application/json" -d "{ \"phone\": \"+8412345611\", \"name\": \"Yojee Sender\", \"email\": \"test123@yojee.com\", \"billing_address\": \"Robinson 188 Road\"}"

Sample Response Body

Server Code Status: 200 => Sender update success

example value(s)

{
"data": {
"billing_address": "Robinson 188 Road",
"email": "test123@yojee.com",
"id": 864,
"inserted_at": "2019-06-04T03:59:51.277209Z",
"name": "Yojee Sender",
"phone": "+8412345645",
"sender_type": "individual",
"user_profile_id": 2392
}
}