Sample Request

curl --request PATCH \
     --url https://api.servetel.in/v1/user/id \
     --header 'accept: application/json' \
     --header 'content-type: application/json' \
     --data-raw '{
    "user_for_cdr": {
        "value": [
            "0502842370261",
            "0502842370002"
        ],
        "type": "agent"
    }
}'

📘 Important!

Before we begin, note that the * sign denotes the mandatory variables in each table.

Request Variables (Path Params)

The following parameter is required to patch a user:

Variable Name	Description	Data Type
id	ID of the user.	String

Request Variables (Body Params)

The following parameter is required to patch a user:

Variable Name	Description	Data Type
name	Name of the user	string
number	Mobile number of the user.	string
email	Email ID of the user.	string
caller_id	Define IDs of the numbers allotted to user. It can be extracted via GET MyNumbers API.	array of strings.
agent_group	The agent groups to allot on a user. For example, sales group.	array of strings.
block_agent	Whether you want to block the user or not.	Boolean
international_outbound	Whether internation outbound is to be enabled or not.	Boolean
designation	Designation of the user.	String
login_id	Define login ID for web login. For example: testuser.	String
user_role	Role ID defined for the user, it can be extracted by editing the role on the web panel and copying it from the URL.	String
password	Define password for web login.	string
block_web_login	Block access to web login	Boolean
user_for_cdr	Users defined for user to see the CDRs.	object (user_for_cdr)
login_based_calling	Whether calling would work based on logging to the application.	Boolean

Response Variables

The response returned is as following:

Variable Name	Description	Data Type
Success	The request success status, the possible values are: True (default) for success. False for failure.	Boolean
Message	The message corresponding to the success status. For example, in 400 Response where the "success" variable pops as True, the message displayed is shown here.	String
Error	The error type is shown is here, if any variable input is not selected properly.	Object