fbpx

< / >

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;

				
			

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

Usamos cookies, se continuar a navegar assumimos que concorda. Pode ler mais sobre a utilização de cookies nas nossas políticas de privacidade e tratamento de dados pessoais

Hacemos uso de cookies, si continúas navegando asumiremos que estás de acuerdo. Puede leer más sobre el uso de cookies en nuestras políticas de privacidad y tratamiento de datos personales