Write

Run an action on an object

Runs a named action on one object. GET /types/{type_name} lists the actions of a type, with a params_schema for each. A call with an API key counts as an agent call. The server refuses an action that can reach a buyer unless a person starts it. An API key needs the ontology:write scope for this call. Keys that you create in the Doris app have ontology:read and events:read only, so they get 403. Rate limit: 60 requests per minute for each workspace.

POST

{type_name}

{object_id}

actions

{action_name}

Run an action on an object

curl --request POST \
  --url https://server.meetdoris.com/api/v1/ontology/{type_name}/{object_id}/actions/{action_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "The buyer confirmed receipt by email."
}
'

import requests

url = "https://server.meetdoris.com/api/v1/ontology/{type_name}/{object_id}/actions/{action_name}"

payload = { "reason": "The buyer confirmed receipt by email." }
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({reason: 'The buyer confirmed receipt by email.'})
};

fetch('https://server.meetdoris.com/api/v1/ontology/{type_name}/{object_id}/actions/{action_name}', 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://server.meetdoris.com/api/v1/ontology/{type_name}/{object_id}/actions/{action_name}",
  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([
    'reason' => 'The buyer confirmed receipt by email.'
  ]),
  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://server.meetdoris.com/api/v1/ontology/{type_name}/{object_id}/actions/{action_name}"

	payload := strings.NewReader("{\n  \"reason\": \"The buyer confirmed receipt by email.\"\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://server.meetdoris.com/api/v1/ontology/{type_name}/{object_id}/actions/{action_name}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"The buyer confirmed receipt by email.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.meetdoris.com/api/v1/ontology/{type_name}/{object_id}/actions/{action_name}")

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  \"reason\": \"The buyer confirmed receipt by email.\"\n}"

response = http.request(request)
puts response.read_body

{}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Authorizations

Authorization

string

header

required

A Doris API key that starts with sk-live-. A workspace admin creates keys in Settings > Workspace > Developer. A key works only on /api/v1/ontology/ routes.

Path Parameters

type_name

string

required

The object type, for example deal, account, person, meeting or commitment. Call GET /types to see the types in your workspace.

Example:

"deal"

object_id

string

required

The object ID.

action_name

string

required

The action name, for example complete on commitment.

Body

application/json

The body is of type object.

Response

The action succeeded. The shape depends on the action.

The response is of type object.

Run an action on an object

curl --request POST \
  --url https://server.meetdoris.com/api/v1/ontology/{type_name}/{object_id}/actions/{action_name} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reason": "The buyer confirmed receipt by email."
}
'

import requests

url = "https://server.meetdoris.com/api/v1/ontology/{type_name}/{object_id}/actions/{action_name}"

payload = { "reason": "The buyer confirmed receipt by email." }
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({reason: 'The buyer confirmed receipt by email.'})
};

fetch('https://server.meetdoris.com/api/v1/ontology/{type_name}/{object_id}/actions/{action_name}', 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://server.meetdoris.com/api/v1/ontology/{type_name}/{object_id}/actions/{action_name}",
  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([
    'reason' => 'The buyer confirmed receipt by email.'
  ]),
  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://server.meetdoris.com/api/v1/ontology/{type_name}/{object_id}/actions/{action_name}"

	payload := strings.NewReader("{\n  \"reason\": \"The buyer confirmed receipt by email.\"\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://server.meetdoris.com/api/v1/ontology/{type_name}/{object_id}/actions/{action_name}")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"reason\": \"The buyer confirmed receipt by email.\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://server.meetdoris.com/api/v1/ontology/{type_name}/{object_id}/actions/{action_name}")

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  \"reason\": \"The buyer confirmed receipt by email.\"\n}"

response = http.request(request)
puts response.read_body

{}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

{
  "error": "<string>",
  "message": "<string>"
}

Get started

Using Doris

Automation

Admin & integrations

Developers

Changelog

Run an action on an object

Authorizations

Path Parameters

Body

Response