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 ESPAÑA Madrid +34 (910) 601 691 MÉXICO Ciudad de México +52 (55) 8526 36 34 BRASIL Brasilia +55 (61) 9836 4127 São Paulo +55 (12) 9811 155 83 ESTADOS UNIDOS New York +1 (914) 373 71 36 REPÚBLICA DOMINICANA Santo Domingo +1 (829) 249 69 68 CHILE Santiago de Chile +56 (2) 240 533 89 GUATEMALA Ciudad de Guatemala +502 (2) 314 1344 PERÚ Lima +51 (1) 644 91 39

< / >

Update

Actualizar registros

URL:

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

Descripción:

El API de actualización nos permite mediante el envío de parámetros actualizar registros en los módulos configurados de nuestro CRM.

¿Cómo funciona?:

Esta API funciona a través de un cuerpo de tipo “raw” y una petición en POST la cual requiere para su correcto funcionamiento los siguientes campos:

– En las cabeceras de la petición se requiere:

Wolkvox-Token

– En el cuerpo de la petición se requiere:

operation
module
wolkvox-id
fields

REQUEST

KEY	DESCRIPCIÓN	EJEMPLO
Wolkvox-Token	Es el token configurado por el cliente en la página de CRM.	A8K3J7F2
wolkvox-id	Es el id del registro. Este lo podemos encontrar como el último parámetro de la URL.	“wolkvox-id”:”64cb”
operation	Es el nombre de la operación del CRM.	“operation”:”modulodeprueba”
module	Nombre del módulo que utilizaremos para actualizar.	“module”:”contacts”
fields	Es el campo que utilizaremos para actualizar todo el formulario de nuestro CRM. Este debe ser utilizado bajo la estructura de un objeto.	“fields”:{ “idcontact”: “1012345678”, “Tipo de cliente”: “VIP”, “Email”: “[email protected]” }

REQUEST

				
					<?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	DESCRIPCIÓN	EJEMPLO
code	Indica el código de estado de la respuesta.	“code”: 200
error	Proporciona detalles sobre el error que ocurrió durante la solicitud.	“error”: “null”
msg	Muestra un mensaje descriptivo sobre el resultado de la solicitud.	“msg”: “Succesfully edit record”
data	Es el conjunto de información obtenido como resultado de haber hecho la solicitud.	“data”: { “wolkvox_id”: “64cb” }
wolkvox_id	Es la identificación del registro en el módulo.	“wolkvox_id”: “64cb”

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

Posibles códigos de error