Launch a DM campaign
curl -X POST https://api.xholic.ai/v1/dm/launch-campaign \ -H "Authorization: Bearer $XHOLIC_API_KEY" \ -H "Content-Type: application/json" \ -d '{"id":"<id>","confirmedConsent":false,"dryRun":true,"idempotencyKey":"my-unique-key-1"}'xholic dm launch-campaign --id '<id>' --dry-run --idempotency-key 'my-unique-key-1'{ "name": "launch_dm_campaign", "arguments": { "id": "<id>", "confirmedConsent": false, "dryRun": true, "idempotencyKey": "my-unique-key-1" }}const response = await fetch("https://api.xholic.ai/v1/dm/launch-campaign", { method: "POST", headers: { Authorization: `Bearer ${process.env.XHOLIC_API_KEY}`, "Content-Type": "application/json", }, body: JSON.stringify({ "id": "<id>", "confirmedConsent": false, "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/launch-campaign", { "id": "<id>", "confirmedConsent": false, "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/launch-campaign", headers={"Authorization": f"Bearer {os.environ['XHOLIC_API_KEY']}"}, json={ "id": "<id>", "confirmedConsent": False, "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(`{"id":"<id>","confirmedConsent":false,"dryRun":true,"idempotencyKey":"my-unique-key-1"}`) req, _ := http.NewRequest("POST", "https://api.xholic.ai/v1/dm/launch-campaign", 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/launch-campaign");curl_setopt_array($ch, [ CURLOPT_RETURNTRANSFER => true, CURLOPT_POST => true, CURLOPT_HTTPHEADER => [ 'Authorization: Bearer ' . getenv('XHOLIC_API_KEY'), 'Content-Type: application/json', ], CURLOPT_POSTFIELDS => '{"id":"<id>","confirmedConsent":false,"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/launch-campaign")req = Net::HTTP::Post.new(uri, "Content-Type" => "application/json")req["Authorization"] = "Bearer #{ENV.fetch("XHOLIC_API_KEY")}"req.body = '{"id":"<id>","confirmedConsent":false,"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"]Launch a reviewed campaign: its messages start sending on its schedule. Run dm.review_campaign first, show the user the outreach guidelines, and pass confirmedConsent true only after they accept. If a template uses [ai_line], launching reserves AI credits for each recipient and needs confirmCredits. Call it only when the user asked for this in the conversation; never on your own initiative.
Uses Xholic AI credits (up to about 0). The first call returns CREDITS_CONFIRMATION_REQUIRED with a quote; after the user agrees, call again with confirmCredits and the quote’s quoteId.
Authorizations
Section titled “Authorizations”Request Bodyrequired
Section titled “Request Bodyrequired”object
DM campaign id.
The user accepted the cold-outreach guidelines shown by dm.review_campaign.
X account to act on, as @handle. Leave it out to use the connection’s default account.
Return exactly what would happen without doing it.
A unique key for this write. Repeating a call with the same key returns the first result instead of acting twice.
Xholic AI credits the user agreed to spend. Call first without it to get the quote, show the quote to the user, and pass the amount only after they say yes.
The quoteId from the quote the user agreed to. Send it with confirmCredits.
Example
{ "id": "<id>", "confirmedConsent": false, "dryRun": true, "idempotencyKey": "my-unique-key-1"}Responses
Section titled “Responses”Success
object
One or two readable sentences about the result.
The result. Its shape depends on the action.
object
Example
{ "ok": true}default
Section titled “default”Error
object
object
Example
{ "ok": false, "error": { "code": "UNAUTHENTICATED", "scope": "account" }}