Ask a person a question

POST/api/v2/agent-mailboxes/:id/ask

Puts a question in the Action center.

Needs an API key with the send scope. Scopes

Parameters

Path

idstringrequired

The agent mailbox id, or me.

Body

questionstringrequired

What you need to know, up to 4,000 characters.

thread_idstring

A conversation the mailbox has received mail in.

Notes

A person types an answer there; read it with the question endpoint.
Returns 202 with the item_id.

curl -X POST "https://api.koltrix.com/api/v2/agent-mailboxes/me/ask" \
  -H "Authorization: Bearer $KOLTRIX_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "question": "Which plan should I offer this customer?"
}'

const res = await fetch("https://api.koltrix.com/api/v2/agent-mailboxes/me/ask", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.KOLTRIX_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "question": "Which plan should I offer this customer?"
  }),
});

console.log(res.status, await res.json());

import os, requests

res = requests.post(
    "https://api.koltrix.com/api/v2/agent-mailboxes/me/ask",
    headers={
        "Authorization": f"Bearer {os.environ['KOLTRIX_API_KEY']}",
    },
    json={
        "question": "Which plan should I offer this customer?"
    },
)
print(res.status_code, res.json())

package main

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

func main() {
	body := strings.NewReader(`{
  "question": "Which plan should I offer this customer?"
}`)
	req, _ := http.NewRequest("POST", "https://api.koltrix.com/api/v2/agent-mailboxes/me/ask", body)
	req.Header.Set("Content-Type", "application/json")
	req.Header.Set("Authorization", "Bearer "+os.Getenv("KOLTRIX_API_KEY"))

	res, err := http.DefaultClient.Do(req)
	if err != nil {
		panic(err)
	}
	defer res.Body.Close()
	out, _ := io.ReadAll(res.Body)
	fmt.Println(res.StatusCode, string(out))
}

<?php

$ch = curl_init("https://api.koltrix.com/api/v2/agent-mailboxes/me/ask");
curl_setopt_array($ch, [
    CURLOPT_CUSTOMREQUEST => "POST",
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_HTTPHEADER => [
        "Authorization: Bearer " . getenv("KOLTRIX_API_KEY"),
        "Content-Type: application/json",
    ],
    CURLOPT_POSTFIELDS => json_encode([
        "question" => "Which plan should I offer this customer?",
    ]),
]);

$response = curl_exec($ch);
echo curl_getinfo($ch, CURLINFO_HTTP_CODE), " ", $response;

Success.

{
  "item_id": "5c4b3a29-1807-4e6d-9c8b-7a6958473625"
}

The body is not valid JSON, or a field has the wrong type.

{
  "error": "invalid body"
}

The API key is missing, malformed, unknown or revoked.

{
  "error": "invalid or revoked api key"
}

The key is valid but does not have the send scope.

{
  "error": "missing permission: send"
}

No such record in this workspace.

{
  "error": "thread not found"
}

More than 60 requests a minute on this key. Wait Retry-After seconds. No code field.

Retry-After: 60

{
  "error": "rate limit exceeded — 60 requests per minute per API key"
}

Try it below with your own key. Every sample reads the key from KOLTRIX_API_KEY.

Try it

Send this request from your browser.

Input

What you send

API key

Stays in this browser tab (sessionStorage) and goes only to api.koltrix.com. Create one under Settings → API keys.

Requests are real and this one changes data in your workspace. Koltrix has no test mode, so use a dedicated key with only the permissions you need and revoke it when you are done.

idstringrequired

questionstringrequired

thread_idstring

Request body · JSON

Valid JSON. The fields above and this editor stay in sync.

POSThttps://api.koltrix.com/api/v2/agent-mailboxes/me/ask

Output

What comes back

The response appears here.
Press Send request.