Welcome drafts

POST

/home/welcome-action

curl -X POST https://api.xholic.ai/v1/home/welcome-action \
  -H "Authorization: Bearer $XHOLIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"workspaceId":"<workspaceId>","action":"dismiss-message","dryRun":true}'

const response = await fetch("https://api.xholic.ai/v1/home/welcome-action", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.XHOLIC_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "workspaceId": "<workspaceId>",
    "action": "dismiss-message",
    "dryRun": true
  }),
});
const result = await response.json();
console.log(result.summary);

import axios from "axios";

const { data } = await axios.post(
  "https://api.xholic.ai/v1/home/welcome-action",
  {
    "workspaceId": "<workspaceId>",
    "action": "dismiss-message",
    "dryRun": true
  },
  { headers: { Authorization: `Bearer ${process.env.XHOLIC_API_KEY}` } },
);
console.log(data.summary);

import os
import requests

response = requests.post(
    "https://api.xholic.ai/v1/home/welcome-action",
    headers={"Authorization": f"Bearer {os.environ['XHOLIC_API_KEY']}"},
    json={
        "workspaceId": "<workspaceId>",
        "action": "dismiss-message",
        "dryRun": True
    },
)
print(response.json()["summary"])

package main

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

func main() {
  body := strings.NewReader(`{"workspaceId":"<workspaceId>","action":"dismiss-message","dryRun":true}`)
  req, _ := http.NewRequest("POST", "https://api.xholic.ai/v1/home/welcome-action", body)
  req.Header.Set("Authorization", "Bearer "+os.Getenv("XHOLIC_API_KEY"))
  req.Header.Set("Content-Type", "application/json")
  res, err := http.DefaultClient.Do(req)
  if err != nil {
    panic(err)
  }
  defer res.Body.Close()
  out, _ := io.ReadAll(res.Body)
  fmt.Println(string(out))
}

<?php
$ch = curl_init("https://api.xholic.ai/v1/home/welcome-action");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('XHOLIC_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => '{"workspaceId":"<workspaceId>","action":"dismiss-message","dryRun":true}',
]);
$result = json_decode(curl_exec($ch), true);
echo $result['summary'];

require "net/http"
require "json"

uri = URI("https://api.xholic.ai/v1/home/welcome-action")
req = Net::HTTP::Post.new(uri, "Content-Type" => "application/json")
req["Authorization"] = "Bearer #{ENV.fetch("XHOLIC_API_KEY")}"
req.body = '{"workspaceId":"<workspaceId>","action":"dismiss-message","dryRun":true}'
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
puts JSON.parse(res.body)["summary"]

Act on the welcome drafts shown after sign-up: dismiss-message hides the intro, dismiss-draft or restore-draft one draft by position, retry rebuilds drafts that failed. Call it only when the user asked for this in the conversation; never on your own initiative.

Authorizations

bearerAuth

Request Body^required

application/json

object

workspaceId

required

WorkspaceUserId from home.feed, so a stale call never acts on another account.

string

>= 1 characters <= 160 characters

action

required

string

Allowed values: dismiss-message dismiss-draft restore-draft retry

position

Required for dismiss-draft and restore-draft: the draft’s position.

integer

<= 2

account

X account to act on, as @handle. Leave it out to use the connection’s default account.

string

>= 1 characters <= 64 characters

dryRun

Return exactly what would happen without doing it.

boolean

idempotencyKey

A unique key for this write. Repeating a call with the same key returns the first result instead of acting twice.

string

>= 8 characters <= 200 characters

Example

{
  "workspaceId": "<workspaceId>",
  "action": "dismiss-message",
  "dryRun": true
}

Responses

200

Success

application/json

object

required

boolean

summary

required

One or two readable sentences about the result.

string

data

required

The result. Its shape depends on the action.

ids

object

key

additional properties

any

next

Array<string>

creditsCharged

number

dryRun

boolean

Example

{
  "ok": true
}

default

Error

application/json

object

required

boolean

error

required

object

code

required

string

Allowed values: UNAUTHENTICATED INVALID_CREDENTIAL SCOPE_MISSING ROLE_NOT_PERMITTED ACCOUNT_NOT_FOUND SUBSCRIPTION_REQUIRED FEATURE_NOT_INCLUDED APP_ONLY INVALID_INPUT NOT_FOUND CONFLICT CREDITS_CONFIRMATION_REQUIRED INSUFFICIENT_CREDITS RATE_LIMITED IDEMPOTENCY_KEY_REUSED IDEMPOTENCY_IN_PROGRESS X_DATA_LIMIT_REACHED UPSTREAM_UNAVAILABLE INTERNAL_ERROR

message

required

string

scope

required

string

Allowed values: account platform

retryAfterSeconds

integer

details

Example

{
  "ok": false,
  "error": {
    "code": "UNAUTHENTICATED",
    "scope": "account"
  }
}

Welcome drafts

Authorizations

Request Bodyrequired

Example

Responses

200

Example

default

Example

Request Body^required