WHY WOLKVOX? OMNICHANNEL PLATFORM WOLKVOX CRM CHATBOTS AND VOICEBOTS MANUALS

COLOMBIA Medellín +57 (4) 322 98 80 Bogotá +57 (1) 381 90 40 Cali +57 (2) 891 28 46 Barranquilla +57 (5) 316 10 34 ARGENTINA Buenos Aires +54 (11) 5217 5933 SPAIN Madrid +34 (910) 601 691 MEXICO Ciudad de México +52 (55) 8526 36 34 BRASIL Brasilia +55 (61) 9836 4127 São Paulo +55 (12) 9811 155 83 UNITED STATES New York +1 (914) 373 71 36 DOMINICAN REPUBLIC Santo Domingo +1 (829) 249 69 68 CHILE Santiago de Chile +56 (2) 240 533 89 GUATEMALA Ciudad de Guatemala +502 (2) 314 1344 PERU Lima +51 (1) 644 91 39

< / >

Update

URL:

https://{{wolkvox_server}}/server/API/v2/custom/update.php

Description:

The update API allows us to update records in the configured modules of our CRM by sending parameters.

How it works?:

This API works through a “raw” type body and a POST request, which requires the following fields for its correct operation:

– In the headers of the request, the following is required:

Wolkvox-Token

– In the body of the request, the following is required:

operation
module
wolkvox-id
fields

How to use the URL?

The API URL contains a placeholder {{crm_server}} that must be replaced with the specific server where the customer operation is located.

Available servers:

Currently, the available servers are:

sv0001.crmvox.com
crm.wolkvox.com

How to determine the CRM server?

Access the CRM homepage using the link: https://crm.wolkvox.com/
Log in using your CRM credentials.
Once you have logged in and are on the homepage of your CRM platform, observe the address bar of your web browser. The URL in this bar indicates the server where your operation is hosted.
Replace {{crm_server}} in the original URL with the specific URL of your CRM server to ensure that the API points correctly to your CRM instance.

Important Notice: Access Route Update

Starting September 1, 2024, new URLs will be implemented to access the wolkvox CRM platform. The current URLs will coexist with the new ones until November 30, 2024, after which they will be disabled.

New URLs:

From “https://sv0001.crmvox.com” to “https://crm0001.wolkvox.com“

From “https://sv0000.crmvox.com” to “https://crm0000.wolkvox.com“

Please ensure you update your integrations and automations before November 30, 2024, to avoid service interruptions.

Insert attachments in base 64

The attachments field allows you to send attachments in base64 format. This field accepts a list of base64 strings that represent the files you want to attach.

"attachments": [ "base64string1", "base64string2" ]

REQUEST

KEY	DESCRIPTION	EXAMPLE
Wolkvox-Token	It is the token configured by the client on the CRM page.	{token}
Wolkvox-id	It is the ID of the record. You can find it as the last parameter in the URL.	6074xxx0801374xxxxx781025xxx7d3
operation	It is the name of the CRM operation.	{operation_name}
module	Module name that we will use for updating.	contacts
fields	It is the field we will use to update the entire form of our CRM. This should be used under the structure of an object.	{“namecontact”: “Jane Doe”}

				
					<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://{{wolkvox_server}}/server/API/v2/custom/update.php',
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => '',
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => 'POST',
  CURLOPT_POSTFIELDS =>'{
    "operation":"{operation}",
    "module":"{module}",
    "wolkvox-id":"{wolkvox-id}",
    "fields":{
        "MyFirstField": "Example"
    }
}',
  CURLOPT_HTTPHEADER => array(
    'Wolkvox-Token: {Wolkvox-Token}',
    'Content-Type: application/json',
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

				
					curl --location --request POST 'https://{{wolkvox_server}}/server/API/v2/custom/update.php' \
--header 'Wolkvox-Token: {Wolkvox-Token}' \
--header 'Content-Type: application/json' \
--data-raw '{
    "operation":"{operation}",
    "module":"{module}",
    "wolkvox-id":"{wolkvox-id}",
    "fields":{
       "MyFirstField": "Example"
    }
}'

				
					OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\r\n    \"operation\":\"{operation}\",\r\n    \"module\":\"{module}\",\r\n    \"wolkvox-id\":\"{wolkvox-id}\",\r\n    \"fields\":{\r\n        \"MyFirstField\":\"Example\"\r\n    }\r\n}");
Request request = new Request.Builder()
  .url("https://{{wolkvox_server}}/server/API/v2/custom/update.php")
  .method("POST", body)
  .addHeader("Wolkvox-Token", "{Wolkvox-Token}")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();

				
					import requests
import json

url = "https://{{wolkvox_server}}/server/API/v2/custom/update.php"

payload = json.dumps({
  "operation": "{operation}",
  "module": "{module}",
  "wolkvox-id": "{wolkvox-id}",
  "fields": {
    "MyFirstField": "Example"
  }
})
headers = {
  'Wolkvox-Token': '7b6d6f64756c6f7465737430317d2d7b32303231313130353131343231337d',
  'Content-Type': 'application/json',
}

response = requests.request("POST", url, headers=headers, data=payload)

print(response.text)

RESPONSE

KEY	DESCRIPTION	EXAMPLE
code	Indicate the status code of the response.	“code”: 200
error	Provide details about the error that occurred during the request.	“error”: “null”
msg	Show a descriptive message about the result of the request.	“msg”: “Succesfully edit record”
data	It is the set of information obtained as a result of having made the request.	“data”: { “wolkvox_id”: “64cb” }
wolkvox_id	This is the record identifier in the module.	“wolkvox_id”: “64cb”

				
					{
    "code": 200,
    "error": "null",
    "msg": "Succesfully edit record",
    "data": {
        "wolkvox_id": "64cb"
    }
}

Possible error codes

< / >

Update

Update

REQUEST

RESPONSE

COLOMBIA

ARGENTINA

BRAZIL

CHILE

SPAIN

UNITED STATES

GUATEMALA

MEXICO

DOMINICAN REPUBLIC

PERU