Set attribute using custom company ID

Set attribute to a company with POST HTTP request.


To set attribute for certain company, the attribute need to exist before proceeding. Head over to "Create attribute" section to create new attribute.

Keep in mind that you have to use name_std as identificator of attribute. This is basically, your attribute name but lowercase all characters.

POST

/companies/:custom_id/set_attribute/

Parameters
Type
Description
company_id
string
Your company custom ID
Data
attribute
string
The name of your attribute. Has to be at least 1 character, and cannot be longer than 32 characters.
value
various types
Type can be boolean, integer, date, string or date & time.
curl -X POST -H "Authorization: Token <your_64_char_api_key>" -H "Content-Type: application/json" -d '{
  "attribute": "Name of the attribute",
  "value": "Value for the attribute"
}' "https://app.userengage.com/api/public/companies-by-id/:company_id/set_attribute/"
var settings = {
  "async": true,
  "crossDomain": true,
  "url": "https://app.userengage.com/api/public/companies-by-id/:company_id/set_attribute/",
  "method": "POST",
  "headers": {
    "authorization": "Token <your_64_char_api_key>",
    "content-type": "application/json"
  },
  "processData": false,
  "data": "{\n  \"attribute\": \"Name of the attribute\",\n  \"value\": \"Value for the attribute\"\n}"
}

$.ajax(settings).done(function (response) {
  console.log(response);
});
var data = JSON.stringify({
  "attribute": "Name of the attribute",
  "value": "Value for the attribute"
});

var xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener("readystatechange", function () {
  if (this.readyState === 4) {
    console.log(this.responseText);
  }
});

xhr.open("POST", "https://app.userengage.com/api/public/companies-by-id/:company_id/set_attribute/");
xhr.setRequestHeader("authorization", "Token <your_64_char_api_key>");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);
var request = require("request");

var options = { method: 'POST',
  url: 'https://app.userengage.com/api/public/companies-by-id/:company_id/set_attribute/',
  headers:
   { 'content-type': 'application/json',
     authorization: 'Token <your_64_char_api_key>' },
  body:
   { attribute: 'Name of the attribute',
     value: 'Value for the attribute' },
  json: true };

request(options, function (error, response, body) {
  if (error) throw new Error(error);

  console.log(body);
});
<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://app.userengage.com/api/public/companies-by-id/:company_id/set_attribute/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => "{\n  \"attribute\": \"Name of the attribute\",\n  \"value\": \"Value for the attribute\"\n}",
  CURLOPT_HTTPHEADER => array(
    "authorization: Token <your_64_char_api_key>",
    "content-type: application/json"
  ),
));

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
import requests

url = "https://app.userengage.com/api/public/companies-by-id/:company_id/set_attribute/"

payload = "{\n  \"attribute\": \"Name of the attribute\",\n  \"value\": \"Value for the attribute\"\n}"
headers = {
    'authorization': "Token <your_64_char_api_key>",
    'content-type': "application/json"
    }

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

print(response.text)
import http.client

conn = http.client.HTTPSConnection("app.userengage.com")

payload = "{\n  \"attribute\": \"Name of the attribute\",\n  \"value\": \"Value for the attribute\"\n}"

headers = {
    'authorization': "Token <your_64_char_api_key>",
    'content-type': "application/json"
    }

conn.request("POST", "/api/public/companies-by-id/:company_id/set_attribute/", payload, headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))