WhatsApp Templates API #

https://api.youraiconnector.com/v1

curl "https://api.youraiconnector.com/v1/whatsapp-templates/provider?apiKey=YOUR_API_KEY"

const res = await fetch("https://api.youraiconnector.com/v1/whatsapp-templates/provider", {
  headers: { "X-API-Key": "YOUR_API_KEY" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api.youraiconnector.com/v1/whatsapp-templates/provider",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
data = res.json()

{
  "success": true,
  "provider": "meta",
  "lane": "meta_cloud_api",
  "waba_id": "2357661648036355",
  "templates_enabled": true
}

curl -X POST "https://api.youraiconnector.com/v1/whatsapp-templates/meta-sync?apiKey=YOUR_API_KEY"

const res = await fetch("https://api.youraiconnector.com/v1/whatsapp-templates/meta-sync", {
  method: "POST",
  headers: { "X-API-Key": "YOUR_API_KEY" },
});
const data = await res.json();

import requests

res = requests.post(
    "https://api.youraiconnector.com/v1/whatsapp-templates/meta-sync",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
data = res.json()

{
  "success": true,
  "provider": "meta",
  "imported": 2,
  "updated": 5,
  "total": 12
}

curl "https://api.youraiconnector.com/v1/whatsapp-templates?apiKey=YOUR_API_KEY"

const res = await fetch("https://api.youraiconnector.com/v1/whatsapp-templates", {
  headers: { "X-API-Key": "YOUR_API_KEY" },
});
const data = await res.json();

import requests

res = requests.get(
    "https://api.youraiconnector.com/v1/whatsapp-templates",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
data = res.json()

{
  "success": true,
  "data": [
    {
      "id": "template_abc123",
      "name": "welcome_message",
      "status": "approved",
      "language": "en",
      "body": "Hi {{first_name}}, thanks for reaching out!"
    },
    {
      "id": "template_def456",
      "name": "appointment_reminder",
      "status": "pending",
      "language": "en",
      "body": "Hi {{first_name}}, this is a reminder about your appointment."
    }
  ]
}

curl "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123" \
  -H "X-API-Key: YOUR_API_KEY"

const res = await fetch(
  "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123",
  { headers: { "X-API-Key": "YOUR_API_KEY" } }
);
const data = await res.json();

import requests

res = requests.get(
    "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
data = res.json()

{
  "success": true,
  "template": {
    "id": "template_abc123",
    "name": "welcome_message",
    "body": "Hi {{first_name}}, thanks for reaching out!",
    "language": "en",
    "variables": ["first_name"],
    "status": "approved",
    "sid": "HXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
    "type": "general",
    "category": "marketing",
    "rejection_reason": null,
    "campaign_id": "campaign123",
    "date_created": "2026-06-01T10:00:00.000Z",
    "date_updated": "2026-06-02T08:30:00.000Z",
    "submitted_at": "2026-06-01T10:05:00.000Z",
    "approved_at": "2026-06-02T08:30:00.000Z"
  }
}

curl -X POST "https://api.youraiconnector.com/v1/whatsapp-templates?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "campaign_id": "campaign123",
    "name": "welcome_message",
    "language": "en",
    "body": "Hi {{first_name}}, thanks for reaching out!",
    "variables": ["first_name"]
  }'

const res = await fetch("https://api.youraiconnector.com/v1/whatsapp-templates", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    campaign_id: "campaign123",
    name: "welcome_message",
    language: "en",
    body: "Hi {{first_name}}, thanks for reaching out!",
    variables: ["first_name"],
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api.youraiconnector.com/v1/whatsapp-templates",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={
        "campaign_id": "campaign123",
        "name": "welcome_message",
        "language": "en",
        "body": "Hi {{first_name}}, thanks for reaching out!",
        "variables": ["first_name"],
    },
)
data = res.json()

{
  "success": true,
  "campaign_status": "pending",
  "template_sid": "HXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

curl -X POST "https://api.youraiconnector.com/v1/whatsapp-templates/docs?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "welcome_message",
    "language": "en",
    "body": "Hi {{first_name}}, thanks for reaching out!",
    "variables": ["first_name"],
    "status": "draft",
    "category": "marketing"
  }'

const res = await fetch("https://api.youraiconnector.com/v1/whatsapp-templates/docs", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "welcome_message",
    language: "en",
    body: "Hi {{first_name}}, thanks for reaching out!",
    variables: ["first_name"],
    status: "draft",
    category: "marketing",
  }),
});
const data = await res.json();

import requests

res = requests.post(
    "https://api.youraiconnector.com/v1/whatsapp-templates/docs",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={
        "name": "welcome_message",
        "language": "en",
        "body": "Hi {{first_name}}, thanks for reaching out!",
        "variables": ["first_name"],
        "status": "draft",
        "category": "marketing",
    },
)
data = res.json()

{
  "success": true,
  "template_id": "template_abc123",
  "status": "draft"
}

curl -X PUT "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123" \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "body": "Hi {{first_name}}, here is an update for you.",
    "variables": ["first_name"]
  }'

const res = await fetch(
  "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123",
  {
    method: "PUT",
    headers: {
      "X-API-Key": "YOUR_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      body: "Hi {{first_name}}, here is an update for you.",
      variables: ["first_name"],
    }),
  }
);
const data = await res.json();

import requests

res = requests.put(
    "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={
        "body": "Hi {{first_name}}, here is an update for you.",
        "variables": ["first_name"],
    },
)
data = res.json()

{
  "success": true,
  "template_id": "template_abc123"
}

curl -X POST "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123/submit" \
  -H "X-API-Key: YOUR_API_KEY"

const res = await fetch(
  "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123/submit",
  { method: "POST", headers: { "X-API-Key": "YOUR_API_KEY" } }
);
const data = await res.json();

import requests

res = requests.post(
    "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123/submit",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
data = res.json()

{
  "success": true,
  "template_id": "template_abc123",
  "status": "pending",
  "sid": "HXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX"
}

curl "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123/status" \
  -H "X-API-Key: YOUR_API_KEY"

const res = await fetch(
  "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123/status",
  { headers: { "X-API-Key": "YOUR_API_KEY" } }
);
const data = await res.json();

import requests

res = requests.get(
    "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123/status",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
data = res.json()

{
  "success": true,
  "template_id": "template_abc123",
  "name": "welcome_message",
  "status": "approved",
  "sid": "HXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "rejection_reason": null,
  "date_updated": "2026-06-02T08:30:00.000Z"
}

Wichtig: Bei einer verwalteten Verbindung wird nur der gespeicherte Datensatz entfernt – Inhalte, die WhatsApp bereits genehmigt hat, können weiterhin beim Messaging-Anbieter registriert bleiben. Bei einem Konto, das über ein eigenes WhatsApp Business-Konto läuft, wird die Vorlage auch aus diesem Konto gelöscht. In jedem Fall gilt: Wenn eine Kampagne diese Vorlage noch verwendet, weisen Sie diese Kampagne vor dem Löschen einer anderen Vorlage zu, da andernfalls darauf basierende Sendungen fehlschlagen.:::

cURL

curl -X DELETE "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const res = await fetch(
  "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123",
  { method: "DELETE", headers: { "X-API-Key": "YOUR_API_KEY" } }
);
const data = await res.json();

Python

import requests

res = requests.delete(
    "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
data = res.json()

Antwort

{
  "success": true,
  "template_id": "template_abc123",
  "note": "The template record was removed from your account. Content already approved by WhatsApp may remain registered with the messaging provider."
}

---

Senden einer Vorlage an einen Kontakt #

Sendet eine genehmigte Vorlage an einen Kontakt, auch wenn kein offenes Gespräch besteht — dies öffnet die Chat-Sitzung erneut. Sie können den Kontakt über contactId oder phoneNumber adressieren und die Vorlage über whatsappTemplateId oder templateName auswählen.

POST /whatsapp-templates/send

Der Textkörper der Vorlage unterstützt erweiterte Variablensubstitution:

• Grundlegende Variablen: {{first_name}}, {{email}}, {{company}}
• Standardwerte: {{first_name|there}} zeigt there an, wenn das Feld leer ist
• Transformationen: {{company|uppercase}}, {{name|lowercase}}, {{name|capitalize}}
• Kombiniert: {{company|Your Company|uppercase}}

Guthaben: Das Senden einer Vorlage verbraucht Guthaben. Die genauen Kosten hängen vom Land des Empfängers und der Kategorie der Vorlage ab.

cURL

curl -X POST "https://api.youraiconnector.com/v1/whatsapp-templates/send?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "contactId": "contact123",
    "whatsappTemplateId": "template_abc123"
  }'

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/whatsapp-templates/send", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    contactId: "contact123",
    whatsappTemplateId: "template_abc123",
  }),
});
const data = await res.json();

Python

import requests

res = requests.post(
    "https://api.youraiconnector.com/v1/whatsapp-templates/send",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={
        "contactId": "contact123",
        "whatsappTemplateId": "template_abc123",
    },
)
data = res.json()

Antwort

{
  "success": true,
  "data": "WhatsApp template message sent successfully"
}

Eine Anfrage, bei der sowohl ein Kontaktbezeichner als auch beide Vorlagenbezeichner fehlen, gibt 400 zurück. Wenn Ihrem Konto die für den Versand erforderlichen Messaging-Anmeldeinformationen fehlen, lautet die Antwort 403.

---

Erstellen oder Aktualisieren einer Live-Vorlage für eine Kampagne #

Ein zweites Paar von Endpunkten für die Eröffnungsvorlage einer Kampagne, die eher über den Pfad als über eine campaign_id im Body definiert werden. Diese sollten für eine bereits aktive Kampagne verwendet werden: Im Gegensatz zu Vorlage erstellen oben führt eine Aktualisierung hier auch dazu, dass die Follow-up-Entwürfe der Kampagne erneut zur Überprüfung eingereicht werden, sodass die Eröffnungsvorlage und ihre Follow-ups synchron bleiben.

POST /whatsapp-templates/campaign/{campaignId} erstellt die Eröffnungsvorlage der Kampagne. PUT /whatsapp-templates/campaign/{campaignId} bearbeitet sie – die Kampagne muss bereits über eine Vorlage verfügen, andernfalls wird 400 zurückgegeben.

cURL (erstellen)

curl -X POST "https://api.youraiconnector.com/v1/whatsapp-templates/campaign/campaign123?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "name": "welcome_message",
    "language": "en",
    "body": "Hi {{first_name}}, thanks for reaching out!",
    "variables": ["first_name"]
  }'

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/whatsapp-templates/campaign/campaign123", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    name: "welcome_message",
    language: "en",
    body: "Hi {{first_name}}, thanks for reaching out!",
    variables: ["first_name"],
  }),
});
const data = await res.json();

Python

import requests

res = requests.post(
    "https://api.youraiconnector.com/v1/whatsapp-templates/campaign/campaign123",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={
        "name": "welcome_message",
        "language": "en",
        "body": "Hi {{first_name}}, thanks for reaching out!",
        "variables": ["first_name"],
    },
)
data = res.json()

Antwort

{
  "success": true,
  "campaign_status": "pending",
  "template_sid": "HXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXXX",
  "message": "WhatsApp template created and campaign updated successfully."
}

Um zu bearbeiten, ändern Sie die Methode auf PUT und verwenden Sie dieselben Felder – dies reicht die Eröffnungsvorlage (und bei einer WhatsApp-API-Kampagne die Follow-up-Entwürfe der Kampagne) erneut zur Überprüfung ein.

Eine Kampagne, die nicht zu Ihrem Konto gehört, gibt 404 zurück; eine Kampagne, die zu einem anderen Konto gehört, für das Sie nicht autorisiert sind, gibt 403 zurück. Das Bearbeiten einer Kampagne ohne vorhandene Vorlage gibt 400 zurück.

---

Senden einer Vorlage an einen bestehenden Kontakt #

Eine einfachere, pfadbasierte Alternative zu Vorlage an einen Kontakt senden oben: Sowohl die Vorlage als auch der Kontakt müssen bereits existieren – es wird nichts anhand des Namens gesucht oder spontan erstellt.

POST /whatsapp-templates/{templateId}/send-to-contact

cURL

curl -X POST "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123/send-to-contact?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "contactId": "contact123" }'

JavaScript

const res = await fetch(
  "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123/send-to-contact",
  {
    method: "POST",
    headers: {
      "X-API-Key": "YOUR_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ contactId: "contact123" }),
  }
);
const data = await res.json();

Python

import requests

res = requests.post(
    "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123/send-to-contact",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={"contactId": "contact123"},
)
data = res.json()

Antwort

{
  "success": true,
  "data": "WhatsApp template message sent successfully"
}

Guthaben: Das Senden verbraucht Guthaben, das genauso berechnet wird wie beim Endpunkt oben. Eine contactId, die fehlt oder nicht zu Ihrem Konto gehört, gibt 403 zurück; ein templateId, der nicht existiert, gibt 404 zurück.

---

Massenversand einer Vorlage #

Senden Sie eine Vorlage in einem einzigen Aufruf an viele Kontakte, mit einer Kostenvorschau, die Sie vor der Bestätigung anzeigen können.

Zuerst die Kosten schätzen #

Gibt die Kosten für den Versand aufgeschlüsselt nach Zielland zurück, ohne etwas zu versenden oder Credits zu verbrauchen. Die Vorlagenpreise gelten pro Zielland, daher muss dies serverseitig anhand der tatsächlichen Kontakte berechnet werden, anstatt es clientseitig zu schätzen.

POST /whatsapp-templates/{templateId}/estimate-bulk-cost

cURL

curl -X POST "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123/estimate-bulk-cost?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "contactIds": ["contact123", "contact456"] }'

JavaScript

const res = await fetch(
  "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123/estimate-bulk-cost",
  {
    method: "POST",
    headers: {
      "X-API-Key": "YOUR_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ contactIds: ["contact123", "contact456"] }),
  }
);
const data = await res.json();

Python

import requests

res = requests.post(
    "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123/estimate-bulk-cost",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={"contactIds": ["contact123", "contact456"]},
)
data = res.json()

Antwort

{
  "success": true,
  "data": {
    "countries": [
      {
        "countryCode": "1",
        "name": "United States",
        "iso": "US",
        "flag": "🇺🇸",
        "contactCount": 120,
        "costPerContact": 0.5,
        "subtotal": 60.0
      }
    ],
    "totalContacts": 120,
    "totalTemplateCost": 60.0,
    "templateCategory": "marketing",
    "skippedContacts": 2
  }
}

skippedContacts zählt IDs, die fehlten, nicht zu Ihrem Konto gehörten oder keine Telefonnummer enthielten — die Schätzung deckt nur den Rest ab, daher bedeutet ein Wert ungleich Null, dass der tatsächliche Versand weniger Kontakte erreicht als von Ihnen ausgewählt.

Den Batch versenden #

Sendet die Vorlage an jeden Kontakt in der Liste, löst alle intelligenten Variablen pro Kontakt auf und berechnet Credits pro Versand.

POST /whatsapp-templates/{templateId}/bulk-send

cURL

curl -X POST "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123/bulk-send?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "contactIds": ["contact123", "contact456"] }'

JavaScript

const res = await fetch(
  "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123/bulk-send",
  {
    method: "POST",
    headers: {
      "X-API-Key": "YOUR_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ contactIds: ["contact123", "contact456"] }),
  }
);
const data = await res.json();

Python

import requests

res = requests.post(
    "https://api.youraiconnector.com/v1/whatsapp-templates/template_abc123/bulk-send",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={"contactIds": ["contact123", "contact456"]},
)
data = res.json()

Antwort

{
  "success": true,
  "data": { "sent": 118, "failed": 2, "total": 120 }
}

Ein Kontakt, bei dem ein Fehler auftritt (nicht gefunden, nicht in Ihrem Konto oder ein Versandfehler), wird übersprungen und in failed gezählt, anstatt den Batch zu stoppen. Ein leeres contactIds, mehr als 5000 IDs bei einem Versand (500 bei einer Schätzung) oder ein fehlendes templateId führt zu 400.

---

Eine fehlgeschlagene Nachricht erneut senden #

Zwei Endpunkte für den erneuten Versand einer fehlgeschlagenen Nachricht, ohne einen neuen Nachrichtendatensatz zu erstellen oder erneut Credits zu verbrauchen.

POST /whatsapp-templates/messages/{contactId}/{messageId}/retry-template versucht speziell den erneuten Versand einer fehlgeschlagenen Vorlagennachricht — der Vorlageninhalt wird aus der Kampagne neu aufgelöst, falls die fehlgeschlagene Nachricht diesen nicht bereits enthält. Nur Nachrichten mit dem Status failed und dem Typ template können auf diese Weise erneut gesendet werden.

POST /whatsapp-templates/messages/{contactId}/{messageId}/retry ist kanalunabhängig und funktioniert für jede fehlgeschlagene Nicht-Vorlagen-Nachricht (zum Beispiel WhatsApp Web), wobei der Versand basierend auf dem Kanal der Nachricht an den richtigen Pfad weitergeleitet wird. Es akzeptiert den Status failed, failed_connection, limit_exceeded oder queued_retry.

Keiner der Endpunkte benötigt einen Request-Body.

cURL

curl -X POST "https://api.youraiconnector.com/v1/whatsapp-templates/messages/contact123/msg_abc789/retry-template?apiKey=YOUR_API_KEY"

JavaScript

const res = await fetch(
  "https://api.youraiconnector.com/v1/whatsapp-templates/messages/contact123/msg_abc789/retry-template",
  { method: "POST", headers: { "X-API-Key": "YOUR_API_KEY" } }
);
const data = await res.json();

Python

import requests

res = requests.post(
    "https://api.youraiconnector.com/v1/whatsapp-templates/messages/contact123/msg_abc789/retry-template",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
data = res.json()

Antwort

{
  "success": true,
  "data": "Message retry initiated successfully"
}

Für die kanalunabhängige Version ändern Sie den Pfad zu .../msg_abc789/retry. Eine Nachricht, deren Status nicht für einen erneuten Versand qualifiziert ist, oder (beim Vorlagen-Endpunkt) die keine Vorlagennachricht ist, führt zu 400. Ein fehlender Kontakt oder eine fehlende Nachricht führt zu 404.

---

WhatsApp Business-Profil #

Verwalten Sie das WhatsApp Business-Profil (Info, Adresse, Beschreibung, E-Mail, Websites, Geschäftskategorie und Logo), das Kontakten auf WhatsApp angezeigt wird. Funktioniert sowohl mit einer verwalteten Verbindung als auch mit einem Konto, das ein eigenes WhatsApp Business-Konto betreibt.

Profil speichern #

PUT /whatsapp-templates/profile

cURL

curl -X PUT "https://api.youraiconnector.com/v1/whatsapp-templates/profile?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumber": "+31612345678",
    "about": "We reply within a few hours",
    "email": "support@example.com",
    "websites": ["https://example.com"]
  }'

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/whatsapp-templates/profile", {
  method: "PUT",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    phoneNumber: "+31612345678",
    about: "We reply within a few hours",
    email: "support@example.com",
    websites: ["https://example.com"],
  }),
});
const data = await res.json();

Python

import requests

res = requests.put(
    "https://api.youraiconnector.com/v1/whatsapp-templates/profile",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={
        "phoneNumber": "+31612345678",
        "about": "We reply within a few hours",
        "email": "support@example.com",
        "websites": ["https://example.com"],
    },
)
data = res.json()

Antwort

{
  "success": true,
  "data": "WhatsApp Business profile updated successfully"
}

Eine fehlende phoneNumber, eine ungültige Website-URL oder eine phoneNumber, die nicht mit Ihrem Konto verbunden ist, führt zu 400 oder 404.

Profilbild hochladen #

Lädt ein Bild von einer von Ihnen bereitgestellten URL herunter und lädt es auf WhatsApp hoch, wobei ein Handle zurückgegeben wird. Übergeben Sie dieses Handle als profilePictureHandle beim oben genannten Aufruf zum Speichern des Profils, um es als Foto festzulegen – dieser Endpunkt lädt das Bild nur hoch, er legt es nicht von selbst fest.

POST /whatsapp-templates/profile/picture

cURL

curl -X POST "https://api.youraiconnector.com/v1/whatsapp-templates/profile/picture?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "phoneNumber": "+31612345678",
    "fileUrl": "https://example.com/logo.png"
  }'

JavaScript

const res = await fetch("https://api.youraiconnector.com/v1/whatsapp-templates/profile/picture", {
  method: "POST",
  headers: {
    "X-API-Key": "YOUR_API_KEY",
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    phoneNumber: "+31612345678",
    fileUrl: "https://example.com/logo.png",
  }),
});
const data = await res.json();

Python

import requests

res = requests.post(
    "https://api.youraiconnector.com/v1/whatsapp-templates/profile/picture",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={
        "phoneNumber": "+31612345678",
        "fileUrl": "https://example.com/logo.png",
    },
)
data = res.json()

Antwort

{
  "success": true,
  "data": "1234567890123456"
}

data ist das Handle des hochgeladenen Bildes. Eine fehlende phoneNumber oder fileUrl oder eine phoneNumber ohne hinterlegtes WhatsApp-Zugriffstoken führt zu 400; eine nicht erreichbare oder ungültige fileUrl gibt einen Fehler zurück, der beschreibt, warum der Download fehlgeschlagen ist.

---

Status eines Absenders prüfen #

Fragt den Live-Sendestatus einer verbundenen WhatsApp-Nummer beim Messaging-Anbieter ab (und aktualisiert ihn). Nützlich, um zu bestätigen, dass eine Nummer tatsächlich senden kann, bevor Sie sich darauf verlassen.

GET /whatsapp-templates/sender-status/{phoneNumber}

cURL

curl "https://api.youraiconnector.com/v1/whatsapp-templates/sender-status/+31612345678" \
  -H "X-API-Key: YOUR_API_KEY"

JavaScript

const res = await fetch(
  "https://api.youraiconnector.com/v1/whatsapp-templates/sender-status/+31612345678",
  { headers: { "X-API-Key": "YOUR_API_KEY" } }
);
const data = await res.json();

Python

import requests

res = requests.get(
    "https://api.youraiconnector.com/v1/whatsapp-templates/sender-status/+31612345678",
    headers={"X-API-Key": "YOUR_API_KEY"},
)
data = res.json()

Antwort

{
  "success": true,
  "data": "ONLINE"
}

data ist einer der Werte ONLINE (sendet normal), PENDING (wird noch verifiziert) oder DELETED (der Anbieter erkennt diesen Absender nicht mehr – verbinden Sie die Nummer erneut). Eine phoneNumber ohne hinterlegte WhatsApp-Geschäftsinformationen führt zu 404.

---

Follow-up-Vorlagen mit KI generieren #

Die Plattform kann die WhatsApp-Follow-up-Vorlagen für eine Kampagne für Sie schreiben – also die Erinnerungen, die gesendet werden, wenn ein Gespräch einschläft – basierend auf den Anweisungen und dem Ziel der Kampagne. Es gibt einen Job-Endpunkt, der im Hintergrund ausgeführt wird, sowie drei ältere Endpunkte, die für bestehende Integrationen beibehalten wurden. Alle verbrauchen KI-Credits.

Einen Generierungs-Job starten #

POST /campaigns/{campaignId}/template-generation

cURL

curl -X POST "https://api.youraiconnector.com/v1/campaigns/campaign_abc123/template-generation?apiKey=YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "type": "all" }'

JavaScript

const res = await fetch(
  "https://api.youraiconnector.com/v1/campaigns/campaign_abc123/template-generation",
  {
    method: "POST",
    headers: {
      "X-API-Key": "YOUR_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({ type: "all" }),
  }
);
const data = await res.json();

Python

import requests

res = requests.post(
    "https://api.youraiconnector.com/v1/campaigns/campaign_abc123/template-generation",
    headers={"X-API-Key": "YOUR_API_KEY"},
    json={"type": "all"},
)
data = res.json()

Antwort (202)

{ "success": true, "campaign_id": "campaign_abc123", "type": "all" }

Der Aufruf kehrt zurück, sobald der Job in die Warteschlange eingereiht wurde. Lesen Sie die Kampagne (GET /campaigns/{campaignId}, siehe Campaigns API) und beobachten Sie deren template_generation_status-Objekt, bis der Vorgang abgeschlossen ist:

Die generierten Vorlagen landen wie jede andere auf der Kampagne, erscheinen also unter Vorlagen auflisten und durchlaufen weiterhin die WhatsApp-Genehmigung, bevor sie gesendet werden können. Ein 400 bedeutet, dass type etwas anderes als all oder cold_only war; ein 404 bedeutet, dass die Kampagne nicht existiert oder zu einem anderen Konto gehört.

Agenten haben ein Pendant zu diesem Aufruf, POST /agents/{agentId}/template-generation, das die Follow-ups für einen Agenten schreibt und im Normalfall während des Aufrufs abgeschlossen wird – siehe Follow-up-Nachrichten generieren in der AI Agents API.

Die älteren Generierungs-Endpunkte #

Drei frühere Endpunkte erledigen dieselbe Arbeit und werden beibehalten, damit bestehende Integrationen weiterhin funktionieren. Neuer Code sollte den oben genannten Job-Endpunkt verwenden.

Alle drei erfordern automatische Follow-ups auf dem Konto und genügend Credits – ein 400 benennt, was fehlt – und das kampagnenadressierte Paar gibt 403 zurück, wenn die Kampagne zu einem anderen Konto gehört.

---

Fehler der Templates-API #

Template-Endpunkte geben das Standard-Fehler-Envelope zurück:

{
  "success": false,
  "error": "Template not found"
}

Ein 404 bei diesen Endpunkten bedeutet normalerweise, dass die Ressource nicht gefunden wurde – entweder existiert sie nicht oder sie gehört zu einem anderen Konto. Einige Endpunkte (das Erstellen/Aktualisieren im Kampagnenkontext und das Senden an einen bestehenden Kontakt) geben stattdessen 403 zurück, wenn die Kampagne oder der Kontakt jemand anderem gehört, anstatt gar nicht zu existieren. Einige Endpunkte enthalten auch ein error_code-Feld, das den HTTP-Status widerspiegelt. Die gemeinsamen Codes, die jeder Endpunkt zurückgeben kann – 400, 401, 403 (Ihr Plan beinhaltet keinen API-Zugriff), 429 (Ratenbegrenzung) und 500 – sind zusammen mit Hinweisen zur Wiederholung unter Fehler & Paginierung aufgeführt.

---

Nächste Schritte #

• Authentifizierung — die vier Möglichkeiten zur Authentifizierung einer Anfrage.
• Fehler & Ratenbegrenzungen — Statuscodes und das Limit von 300 Anfragen/Min.
• Kampagnen-API — Verwalten Sie die Kampagnen, denen Vorlagen zugeordnet sind.