Accounts

📘
Do you have any questions on our Email API? Write to us at [email protected]

/account/viewUserDetail

Retrieve account user details.

Example Request

{
    "owner_id":"example id",
    "token":"example token"
}

Example Success Response

{
    "status": "success",
    "user_data":{
        "name":"john yu",
        "email":"[email protected]",
        "mobile":"9999999999",
        "create_date":67457775764,
        "allowed_speed":300,
        "reputation":"50%"
    }
}

Example Error Response

{
    "status": "error",
    "code": -1,
    "name": "AuthenticationError",
    "message": "Token MissMatch"
}

Parameters

Parameter	Type	Description
owner_id*	string	a valid SendCleanUser Id
token*	string	a valid token

*compulsory field

Return Value: Success

struct — the results of retrieving user details

Field	Type	Description
status	string	success
user_data	struct	user detail object

user_datafields:

Field	Type	Description
name	string	user's full name
email	string	user's email address
mobile	string	user's mobile number
create_date	integer	account creation date in seconds
allowed_speed	integer	allowed sending speed
reputation	string	sender reputation percentage

Return Value: Error

struct — the error results when attempting to retrieve user details

Field	Type	Description
status	string	error
code	integer	error code
name	string	error type name
message	string	human readable message

Error Types

ValidationError — The parameters passed to the API call are invalid or not provided when required.

GeneralError — An unexpected error occurred processing the request. SendClean Developers will be notified.

AuthenticationError — Provided owner_id and token was not matched.