Skip to main content
POST
/
{custom_object_api_name}
/
_upsert
Upsert a custom-object record
curl --request POST \
  --url https://api.reevo.ai/api/v2/public/{custom_object_api_name}/_upsert \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "attributes": {
    "display_name": {
      "value": "<string>",
      "value_type": "string"
    }
  },
  "match": {
    "field": "<string>",
    "value": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
  }
}
'
import requests

url = "https://api.reevo.ai/api/v2/public/{custom_object_api_name}/_upsert"

payload = {
    "attributes": { "display_name": {
            "value": "<string>",
            "value_type": "string"
        } },
    "match": {
        "field": "<string>",
        "value": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
    }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    attributes: {display_name: {value: '<string>', value_type: 'string'}},
    match: {field: '<string>', value: '3c90c3cc-0d44-4b50-8888-8dd25736052a'}
  })
};

fetch('https://api.reevo.ai/api/v2/public/{custom_object_api_name}/_upsert', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.reevo.ai/api/v2/public/{custom_object_api_name}/_upsert",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'attributes' => [
        'display_name' => [
                'value' => '<string>',
                'value_type' => 'string'
        ]
    ],
    'match' => [
        'field' => '<string>',
        'value' => '3c90c3cc-0d44-4b50-8888-8dd25736052a'
    ]
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>",
    "Content-Type: application/json"
  ],
]);

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

curl_close($curl);

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

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.reevo.ai/api/v2/public/{custom_object_api_name}/_upsert"

	payload := strings.NewReader("{\n  \"attributes\": {\n    \"display_name\": {\n      \"value\": \"<string>\",\n      \"value_type\": \"string\"\n    }\n  },\n  \"match\": {\n    \"field\": \"<string>\",\n    \"value\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://api.reevo.ai/api/v2/public/{custom_object_api_name}/_upsert")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"attributes\": {\n    \"display_name\": {\n      \"value\": \"<string>\",\n      \"value_type\": \"string\"\n    }\n  },\n  \"match\": {\n    \"field\": \"<string>\",\n    \"value\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}")
  .asString();
require 'uri'
require 'net/http'

url = URI("https://api.reevo.ai/api/v2/public/{custom_object_api_name}/_upsert")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"attributes\": {\n    \"display_name\": {\n      \"value\": \"<string>\",\n      \"value_type\": \"string\"\n    }\n  },\n  \"match\": {\n    \"field\": \"<string>\",\n    \"value\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\"\n  }\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "record_type": "<string>",
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "attributes": {
      "id": {
        "value": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
        "value_type": "uuid"
      },
      "created_at": {
        "value": "2023-11-07T05:31:56Z",
        "value_type": "timestamp"
      },
      "display_name": {
        "value": "<string>",
        "value_type": "string"
      },
      "updated_at": {
        "value": "2023-11-07T05:31:56Z",
        "value_type": "timestamp"
      }
    }
  },
  "meta": {
    "matched_on": {}
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}
{
  "status_code": 123,
  "error_type": "<string>",
  "message": "<string>",
  "details": {
    "loc": [
      "<unknown>"
    ],
    "type": "<string>",
    "all_errors": [
      "<unknown>"
    ],
    "code": "request_validation_failed"
  }
}

Authorizations

​
Authorization
string
header
required

Reevo API key passed as Authorization: Bearer <api-key>.

Path Parameters

​
custom_object_api_name
string
required

Full custom-object api_name, including the cus_obj__ prefix (e.g. cus_obj__pet_crud_ab12cd). Discover available custom objects via GET /_organization_schema_summary.

Example:

"cus_obj__pet_crud_ab12cd"

Body

application/json
​
attributes
CustomObjectCreateRequestAttributes · object
required
​
match
RecordMatch · object
required

Match envelope where attribute is a dot-notation public schema path.

Response

Successful Response

{"data": <record>, "meta": ...} — _upsert.

​
data
CustomObjectObjectRecord · object
required
​
meta
UpsertMeta · object
required

Metadata describing the outcome of an upsert call.