Import leads for DMs

POST

/dm/queue-import

curl -X POST https://api.xholic.ai/v1/dm/queue-import \
  -H "Authorization: Bearer $XHOLIC_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"source":{"kind":"FOLLOWERS"},"maxProfiles":1,"dryRun":true}'

const response = await fetch("https://api.xholic.ai/v1/dm/queue-import", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.XHOLIC_API_KEY}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "source": {
      "kind": "FOLLOWERS"
    },
    "maxProfiles": 1,
    "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/dm/queue-import",
  {
    "source": {
      "kind": "FOLLOWERS"
    },
    "maxProfiles": 1,
    "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/dm/queue-import",
    headers={"Authorization": f"Bearer {os.environ['XHOLIC_API_KEY']}"},
    json={
        "source": {
            "kind": "FOLLOWERS"
        },
        "maxProfiles": 1,
        "dryRun": True
    },
)
print(response.json()["summary"])

package main

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

func main() {
  body := strings.NewReader(`{"source":{"kind":"FOLLOWERS"},"maxProfiles":1,"dryRun":true}`)
  req, _ := http.NewRequest("POST", "https://api.xholic.ai/v1/dm/queue-import", 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/queue-import");
curl_setopt_array($ch, [
    CURLOPT_RETURNTRANSFER => true,
    CURLOPT_POST => true,
    CURLOPT_HTTPHEADER => [
        'Authorization: Bearer ' . getenv('XHOLIC_API_KEY'),
        'Content-Type: application/json',
    ],
    CURLOPT_POSTFIELDS => '{"source":{"kind":"FOLLOWERS"},"maxProfiles":1,"dryRun":true}',
]);
$result = json_decode(curl_exec($ch), true);
echo $result['summary'];

require "net/http"
require "json"

uri = URI("https://api.xholic.ai/v1/dm/queue-import")
req = Net::HTTP::Post.new(uri, "Content-Type" => "application/json")
req["Authorization"] = "Bearer #{ENV.fetch("XHOLIC_API_KEY")}"
req.body = '{"source":{"kind":"FOLLOWERS"},"maxProfiles":1,"dryRun":true}'
res = Net::HTTP.start(uri.host, uri.port, use_ssl: true) { |http| http.request(req) }
puts JSON.parse(res.body)["summary"]

Queue an import of X profiles into a contact list for DM campaigns. Runs in the background and uses the plan’s import pool; estimate it first with dm.estimate_import. 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

source

required

Who to import. FOLLOWERS/FOLLOWING {handle}; KEYWORD_POSTERS {query, days?, language?, excludeHandles?}; X_LIST/LIST_FOLLOWERS {listUrl}; POST_ENGAGERS {tweetUrl, includeReplies?, includeReposts?, keyword?}; HANDLES {handles}.

object

kind

required

string

Allowed values: FOLLOWERS FOLLOWING KEYWORD_POSTERS X_LIST LIST_FOLLOWERS POST_ENGAGERS HANDLES

key

additional properties

filters

Optional filters: followersMin, followersMax, bioIncludes, bioExcludes, locationIncludes, verified (any|only|exclude), dmsOpenOnly, excludeProtected, excludeAutomated, minAccountAgeDays.

object

key

additional properties

maxProfiles

required

integer

>= 1 <= 15000

listId

Contact list to import into.

string format: uuid

nullable /^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$/

newListName

Name for a new list instead. Pass exactly one of listId or newListName.

string

nullable >= 1 characters <= 80 characters

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

{
  "source": {
    "kind": "FOLLOWERS"
  },
  "maxProfiles": 1,
  "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"
  }
}

Import leads for DMs

Authorizations

Request Bodyrequired

Example

Responses

200

Example

default

Example

Request Body^required