Updating Data

Updating Data

Updates records that match key/value pairs provided

GET https://example.mydomain.com/api/update-records-by-matching-values

Request Body

Name	Type	Description
blocId*	integer	The ID of the bloc you want to update data in. This is the last number in the URL of the bloc, in this example it is 1234: https://example.mydomain.com/module/module-name/bloc/1234
fieldsToUpdate	object	The field slugs and their values you want to update. { "employee_name" : "Jane Doe", "a_different_field" : "More Data" }
searchItems	object	The field slugs and their values that need to match to find records to update. { "employee_id" : "5830"}

200 Data Response Array of updated Record IDs

{
    "updated_record_ids": [
        1223259
    ]
}

401 Permission denied

{
    "error": "You are not authorized to access this bloc"
}

400: Bad Request Bad Request

{
    "error": [ERROR MESSAGE HERE]
}

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => 'https://example.mydomain.com/api/update-records-by-matching-values',
  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 =>'{
    "blocId": "1234",
    "fieldsToUpdate" : {
        "employee_name" : "Jane Doe",
        "more_infor" : "More Info"
    },
    "searchItems": {
        "employee_id": "12345"
    }
}',
  CURLOPT_HTTPHEADER => array(
    'Authorization: Bearer [AUTHTOKEN]',
    'Content-Type: application/json'
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

jQuery

var settings = {
  "url": "https://example.mydomain.com/api/update-records-by-matching-values",
  "method": "POST",
  "timeout": 0,
  "headers": {
    "Authorization": "Bearer [AUTHTOKEN]",
    "Content-Type": "application/json"
  },
  "data": JSON.stringify({
    "blocId": "1234",
    "fieldsToUpdate": {
      "employee_name": "Jane Doe",
      "more_infor": "More Info"
    },
    "searchItems": {
      "employee_id": "12345"
    }
  }),
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

Node JS

var request = require('request');
var options = {
  'method': 'POST',
  'url': 'https://example.mydomain.com/api/update-records-by-matching-values',
  'headers': {
    'Authorization': 'Bearer [AUTHTOKEN]',
    'Content-Type': 'application/json'
  },
  body: JSON.stringify({
    "blocId": "1234",
    "fieldsToUpdate": {
      "employee_name": "Jane Doe",
      "more_infor": "More Info"
    },
    "searchItems": {
      "employee_id": "12345"
    }
  })

};
request(options, function (error, response) {
  if (error) throw new Error(error);
  console.log(response.body);
});

Python

import http.client
import json

conn = http.client.HTTPSConnection("example.mydomain.com")
payload = json.dumps({
  "blocId": "1234",
  "fieldsToUpdate": {
    "employee_name": "Jane Doe",
    "more_infor": "More Info"
  },
  "searchItems": {
    "employee_id": "12345"
  }
})
headers = {
  'Authorization': 'Bearer [AUTHTOKEN]',
  'Content-Type': 'application/json'
}
conn.request("POST", "/api/update-records-by-matching-values", payload, headers)
res = conn.getresponse()
data = res.read()
print(data.decode("utf-8"))