Sign In
Sign Up

Sender / Create

Create new sender

Request Header Authorization
Authentication Yes

API Endpoint

{{ServerUrl}}api/v1/sender/create
POST

API Parameters

Request Parameter

Field DataType Required Description
affiliateSenderId string Yes Affiliate sender reference
titleId integer No title id
firstName string Yes first name
lastName string Yes last name
address string Yes address
suburb string No suburb
state string No state
postcode string No postcode
countryCode string Yes country code (Alpha-3 code)
phoneCountryCode string No phone country code
phoneNo string No phone no
dateOfBirth string No date of birth
email string No email
occupation string No occupation
placeOfBirthCountryCode string No place of birth country code (Alpha-3 code)
nationalityCode string Yes nationality code (Alpha-3 code)
senderTypeCode string Yes sender type code (I=Individual, C=Company)

Response Parameter

Field DataType Description
status string response status
message string response message
payload
id integer generated sender id

Sample JSON Request:

				
					{
    "affiliateSenderId": "PRASIT.SRIKET5",
    "titleId": 1,
    "firstName": "Prasit00001",
    "lastName": "Sriket",
    "address": "17/20",
    "suburb": "Aus",
    "state": "Aus",
    "postcode": "10240",
    "countryCode": "THA",
    "phoneCountryCode": "66",
    "phoneNo": "66815981742",
    "dateOfBirth": "1990-01-29T00:00:00",
    "email": "josriket@gmail.com",
    "occupation": null,
    "placeOfBirthCountryCode": "THA",
    "nationalityCode": "THA",
    "senderTypeCode": "I"
}

Response Codes and Statuses

Status Code Error Description
000 Success

Error Codes

Status Code Error Description
101 General/Process error (see message)
301 Permission denined
401 Unauthorized
500 Internal server error (see message)

Sample JSON Responses: Success

				
					{
    "status": "000",
    "message": "Success",
    "payload": {
        "id": 124
    }
}

Change Log