POST/users/update_or_create/

Update or create user

You can create or update users based on the "custom_id" key value. If a user with the provided value exists, we will update his profile with provided data, otherwise, a new user will be created. You can also set up any custom attribute of your choice. Custom attributes have to be created in the User.com app before sending them within requests.

Attributes	Type	Required	Description
custom_id	string	no	The unique identifier for the user which is provided by the client.
company_custom_id	string	no	A unique identifier for the company which is provided by the client.
custom_attr	string	no	An example value of your custom attribute.
email	string	no	A user email address.
first_name	string	no	A first name for a user (the maximum number of characters is 40).
last_name	string	no	A last name for a user (the maximum number of characters is 40).
tags	list(strings)	no	A list of tag names.

Request

CURL

 curl -X POST -H "Authorization: Token <your_64_char_api_key>"
     -H "Accept: */*; version=2" -H "Content-Type: application/json" -d '{
  "custom_id": "my_custom_id",
  "first_name": "John",
  "last_name": "Doe",
  "tags": ["updated", "verified"]
}' "https://<your_app_subdomain>.user.com/api/public/users/update_or_create/"

JavaScript

var data = "custom_id=my_custom_id&first_name=John&last_name=Doe";

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

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

xhr.open("POST", "https://<your_app_subdomain>.user.com/api/public/users/update_or_create/");
xhr.setRequestHeader("authorization", "Token <your_64_char_api_key>");
xhr.setRequestHeader("accept", "*/*; version=2");
xhr.setRequestHeader("content-type", "application/json");

xhr.send(data);

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
  CURLOPT_URL => "https://<your_app_subdomain>.user.com/api/public/users/update_or_create/",
  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  \"custom_id\": \"my_custom_id\",\n  \"first_name\": \"John\",\n  \"last_name\": \"Doe\"\n}",
  CURLOPT_HTTPHEADER => array(
      "Accept: */*; version=2",
    "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;
}

Python

import requests

url = "https://<your_app_subdomain>.user.com/api/public/users/update_or_create/"

payload = "{\n\"custom_id\": \"my_custom_id\", \n\"first_name\":\"John\", \n\"last_name\":\"Doe\" \n}"
headers = {
    'authorization': "Token <your_64_char_api_key>",
     'Accept': "*/*; version=2",
    'content-type': "application/json"
    }

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

print(response.text)

Response

{
  "created": true,
  "id": 5577
}