All plans have 30% OFF For this week

Claim Discount

API referentie: acties-eindpunt

De Acties API laat je automatiseringsacties in AnswerPal beheren. Gebruik deze eindpunten om acties die je automatiseringsworkflows aansturen te bekijken, maken, updaten en verwijderen.

Overzicht

Acties zijn vooraf gedefinieerde handelingen die kunnen worden geactiveerd bij specifieke gebeurtenissen in de AnswerPal-workflow (zoals na onderwerpsdetectie of wanneer een ticket wordt geëscaleerd). Met de Acties API kun je deze acties programmatisch beheren, waardoor je flexibele automatisering voor klantenservice, interne ondersteuning en meer mogelijk maakt.

Authenticatie

Alle Acties API eindpunten vereisen authenticatie. Voeg een geldige toegangstoken toe in de `Authorization` header van je verzoeken.

Eindpunten

GET /api/Actions

Retrieve a paginated list of actions for the authenticated customer. Query Parameters:
  • pageNumber (integer, default: 1)  — Page number for pagination.
  • pageSize (integer, default: 10) — Number of items per page.
  • sortBy (string, default: “Name”) — Field to sort by.
  • sortOrder (string, default: “asc”) — Sort order (“asc” or “desc”).
GET /api/Actions?pageNumber=1&pageSize=10&sortBy=Name&sortOrder=asc
Authorization: Bearer <token>

Response Example

{
  "items": [
    {
      "actionID": 1,
      "name": "Auto Close",
      "description": "Automatically close resolved tickets",
      "priority": 90,
      "isActive": true
    },
    ...
  ],
  "totalCount": 20,
  "totalPages": 2
}

 GET /api/Actions/{id}

Retrieve a single action by its unique ID.

Path Parameters:

  • id (integer, required) — The ID of the action.
GET /api/Actions/1
Authorization: Bearer <token>

Response Example

{
  "actionID": 1,
  "name": "Auto Close",
  "description": "Automatically close resolved tickets",
  "priority": 90,
  "isActive": true
}

POST /api/Actions

Create a new action.

Request Body (JSON):

  • name (string, required)
  • description (string, optional)
  • priority (integer, required)
  • isActive (boolean, required)
POST /api/Actions
Authorization: Bearer <token>
Content-Type: application/json

{
  "name": "Forward to Supervisor",
  "description": "Forward urgent tickets to supervisor",
  "priority": 100,
  "isActive": true
}

Response Example

{
  "actionID": 2,
  "name": "Forward to Supervisor",
  "description": "Forward urgent tickets to supervisor",
  "priority": 100,
  "isActive": true
}

PUT /api/Actions/{id}

Update an existing action.

Path Parameters:

  • id (integer, required)

Request Body (JSON):

  • actionID (integer, required, must match path)
  • name (string, required)
  • description (string, optional)
  • priority (integer, required)
  • isActive (boolean, required)
PUT /api/Actions/2
Authorization: Bearer <token>
Content-Type: application/json

{
  "actionID": 2,
  "name": "Forward to Supervisor",
  "description": "Forward urgent tickets to supervisor (updated)",
  "priority": 100,
  "isActive": true
}

Response Example

HTTP/1.1 204 No Content

DELETE /api/Actions/{id}

Delete an action by its ID.

Path Parameters:

  • id (integer, required)
DELETE /api/Actions/2
Authorization: Bearer <token>

Response Example

HTTP/1.1 204 No Content

Foutcodes

  • 400 Fout verzoek: Ongeldige invoer of ID-mismatch.
  • 401 Ongeautoriseerd: Authenticatie mislukt of ontbreekt.
  • 404 Niet gevonden: Actie bestaat niet.
  • 409 Conflict: Dubbele actie of conflicterende gegevens (bij creëren).
  • 201 Aangemaakt: Actie succesvol aangemaakt.
  • 204 Geen inhoud: Update of verwijdering succesvol.

Best practices

  • Check altijd op `204 Geen inhoud` bij updaten/verwijderen—er wordt geen body geretourneerd.
  • Gebruik paginering en sortering voor grote actielijsten.
  • Gebruik duidelijke, beschrijvende namen en prioriteiten voor acties.
  • Deactiveer acties (in plaats van ze te verwijderen) die je misschien moet herstellen.

FAQ

Je moet geauthenticeerd zijn; toegang is beperkt tot de data van je organisatie.

De actie wordt verwijderd en zal niet meer worden uitgevoerd in toekomstige workflows.

Ja, gebruik het Update-eindpunt en geef de nieuwe prioriteit op.

Naam, prioriteit en isActive zijn verplicht.

Inhoudsopgave

AnswerPal: AI-powered customer service solutions to elevate your support and communication effortlessly.

Contact

For all support, sales, and partnership inquiries, email us at info@answerpal.eu