Patch a User

This API allows you to update/Block/Unblock an existing User.

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 NameDescriptionData Type
idID of the user.String

Request Variables (Body Params)

The following parameter is required to patch a user:

Variable NameDescriptionData Type
nameName of the userstring
numberMobile number of the user.string
emailEmail ID of the user.string
caller_idDefine IDs of the numbers allotted to user. It can be extracted via GET MyNumbers API.array of strings.
agent_groupThe agent groups to allot on a user. For example, sales group.array of strings.
block_agentWhether you want to block the user or not.Boolean
international_outboundWhether internation outbound is to be enabled or not.Boolean
designationDesignation of the user.String
login_idDefine login ID for web login. For example: testuser.String
user_roleRole ID defined for the user, it can be extracted by editing the role on the web panel and copying it from the URL.String
passwordDefine password for web login.string
block_web_loginBlock access to web loginBoolean
user_for_cdrUsers defined for user to see the CDRs.object (user_for_cdr)
login_based_callingWhether calling would work based on logging to the application.Boolean

Response Variables

The response returned is as following:

Variable NameDescriptionData Type
SuccessThe request success status, the possible values are: True (default) for success. False for failure.Boolean
MessageThe 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
ErrorThe error type is shown is here, if any variable input is not selected properly.Object
Language
Click Try It! to start a request and see the response here!