Search
Close this search box.

< / >

APIs

13. Edit agent

URL:

https://wv{{wolkvox_server}}.wolkvox.com/api/v2/configuration.php?api=edit_agent&agent_id={{agent_id}}

Description:

This API allows you to update or edit an agent’s information.

Benefit: Optimize processes and time by editing agent information from external solutions.

Type of request:

PUT

How it works:

  • The consumption of this API is done by PUT method.
  • In the json the parameters are added according to the operation or process to be performed.
  • To consume this API you must replace in the url {{{wolkvox_server}} by the nomenclature of the server of the operation.
  • The wolkvox-token header must be used to make use of the authorization token.
  • Note that the same token cannot be consumed simultaneously, so you can schedule the next API to be consumed when the result of the previous one is successful.
  • The field “agent_sso”: “” is optional and allows users to log in to the system using their existing authentication credentials, without the need to provide separate login information for our software.
  • The field for assigning a password “agent_pass”: “” can remain empty, and the system will assign a random password.
  • The password must have at least one uppercase letter, one lowercase letter, one number, and one special character (!#%&*@).
  • Limit of records that can be downloaded per consumption: 60,000 records.
  • Limit of records that can be uploaded per consumption: 10,000 records.
  • Limit of days queried in dates: 31 days.
  • Limit of result weight: 256 MB.
  • API consumption time limit: 60 seconds.
  • Concurrent consumption limit of a token: 2 simultaneous requests.
  • Daily limit of tokens: Number of licenses multiplied by 1000 daily tokens.

Request

NAME DESCRIPTION TYPE
agent_id Refers to the numerical identification String
agent_dni Agent’s identification document number. String
agent_name Agent’s Name. String
agent_sso Single Sign-On (SSO) is an optional feature that allows users to log in to the system using their existing authentication credentials, without the need to provide separate login information for our software. String
agent_pass Password you want to assign to the agent. String
 

Response

NAME DESCRIPTION TYPE
code Response code int
error Error String
msg Description of the response String
Possible response codes

RESPONSE

				
					{
    "code": 202,
    "error": null,
    "msg": "agent has been updated"
}
				
			
We use cookies, if you continue browsing we will assume that you agree. You can read more about the use of cookies in our privacy policies and treatment of personal data