Add a keyword auto-reply
POST
/dm/create-inbound-rule
curl -X POST https://api.xholic.ai/v1/dm/create-inbound-rule \ -H "Authorization: Bearer $XHOLIC_API_KEY" \ -H "Content-Type: application/json" \ -d '{"keyword":"<keyword>","replyTemplate":"<replyTemplate>","dryRun":true,"idempotencyKey":"my-unique-key-1"}'xholic dm create-inbound-rule --keyword '<keyword>' --reply-template '<replyTemplate>' --dry-run --idempotency-key 'my-unique-key-1'{ "name": "dm_create_inbound_rule", "arguments": { "keyword": "<keyword>", "replyTemplate": "<replyTemplate>", "dryRun": true, "idempotencyKey": "my-unique-key-1" }}const response = await fetch("https://api.xholic.ai/v1/dm/create-inbound-rule", { method: "POST", headers: { Authorization: `Bearer ${process.env.XHOLIC_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "keyword": "<keyword>", "replyTemplate": "<replyTemplate>", "dryRun": true, "idempotencyKey": "my-unique-key-1" }),});const result = await response.json();console.log(result.summary);import axios from "axios";
const { data } = await axios.post( "https://api.xholic.ai/v1/dm/create-inbound-rule", { "keyword": "<keyword>", "replyTemplate": "<replyTemplate>", "dryRun": true, "idempotencyKey": "my-unique-key-1" }, { headers: { Authorization: `Bearer ${process.env.XHOLIC_API_KEY}` } },);console.log(data.summary);import osimport requests
response = requests.post( "https://api.xholic.ai/v1/dm/create-inbound-rule", headers={"Authorization": f"Bearer {os.environ['XHOLIC_API_KEY']}"}, json={ "keyword": "<keyword>", "replyTemplate": "<replyTemplate>", "dryRun": True, "idempotencyKey": "my-unique-key-1" },)print(response.json()["summary"])package main
import ( "fmt" "io" "net/http" "os" "strings")
func main() { body := strings.NewReader(`{"keyword":"<keyword>","replyTemplate":"<replyTemplate>","dryRun":true,"idempotencyKey":"my-unique-key-1"}`) req, _ := http.NewRequest("POST", "https://api.xholic.ai/v1/dm/create-inbound-rule", 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/dm/create-inbound-rule");curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ' . getenv('XHOLIC_API_KEY'), 'Content-Type: application/json', ], CURLOPT_POSTFIELDS => '{"keyword":"<keyword>","replyTemplate":"<replyTemplate>","dryRun":true,"idempotencyKey":"my-unique-key-1"}',]);$result = json_decode(curl_exec($ch), true);echo $result['summary'];require "net/http"require "json"
uri = URI("https://api.xholic.ai/v1/dm/create-inbound-rule")req = Net::HTTP::Post.new(uri, "Content-Type" => "application/json")req["Authorization"] = "Bearer #{ENV.fetch("XHOLIC_API_KEY")}"req.body = '{"keyword":"<keyword>","replyTemplate":"<replyTemplate>","dryRun":true,"idempotencyKey":"my-unique-key-1"}'res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }puts JSON.parse(res.body)["summary"]Add a rule that automatically DMs replyTemplate to anyone who sends the keyword. Write the reply yourself. Call it only when the user asked for this in the conversation; never on your own initiative.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”Media typeapplication/json
object
keyword
required
A single word, like GUIDE.
string
replyTemplate
required
The message. Variables: [first], [name], [handle], [location], [followers], list fields such as [first_line], with optional fallbacks like [first|there]; spintax like {Hi|Hey}. Write it yourself in the user’s voice.
string
active
boolean
account
X account to act on, as @handle. Leave it out to use the connection’s default account.
string
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
Example
{ "keyword": "<keyword>", "replyTemplate": "<replyTemplate>", "dryRun": true, "idempotencyKey": "my-unique-key-1"}Responses
Section titled “Responses”Success
Media typeapplication/json
object
ok
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
Section titled “default”Error
Media typeapplication/json
object
ok
required
boolean
error
required
object
code
required
string
message
required
string
scope
required
string
retryAfterSeconds
integer
details
Example
{ "ok": false, "error": { "code": "UNAUTHENTICATED", "scope": "account" }}