Plixa API

Introduction

REST API for the Plixa SaaS — WhatsApp customer service for small and medium businesses.

Base URL: https://api.plixa.app

Plixa is API-first. Every action the customer panel takes is also available through this API, and the same contract powers the official SDKs and partner integrations.

All routes live under /v1/. Breaking changes ship as /v2/, never as silent updates to /v1/.

Quickstart

Generate an API token at app.plixa.app → Settings → API tokens.

Send the token as a bearer header on every request:

curl https://api.plixa.app/v1/me \
-H "Authorization: Bearer YOUR_TOKEN" \
-H "Accept: application/json"

Response envelope

Every endpoint returns the same JSON shape — the panel and SDKs rely on this consistency:

{ "data": { ... }, "meta": null, "errors": null }

Errors carry a machine-readable code so SDKs can switch on it instead of parsing English:

{
  "data": null,
  "meta": null,
  "errors": [{ "code": "AI_PLAN_REQUIRED", "message": "..." }]
}

Rate limits

Mutating endpoints (sending messages, AI previews) are rate-limited per tenant. When a limit is hit the response is HTTP 429 with the usual Retry-After header — back off and retry.

Webhooks

Plixa pushes events (new conversations, inbound messages, status changes) to URLs you configure in the panel. Payloads are signed with HMAC-SHA256 in the X-Plixa-Signature header so you can verify authenticity. See the Webhooks group below.

Authenticating requests

To authenticate requests, include an Authorization header with the value "Bearer {PLIXA_API_TOKEN}".

All authenticated endpoints are marked with a requires authentication badge in the documentation below.

Generate a token by calling POST /v1/auth/login or POST /v1/auth/register. Send it as Authorization: Bearer {token}.

AI configuration

On-demand quick-reply suggestions inside the inbox. Calls the AI provider once and returns 3 short, distinct candidates an operator can click into the composer, edit and send. Plan-gated to the same tier that allows automated replies — and rate-limited so the "click again" pattern can't blow the token budget.

Preview an AI reply without sending anything

POST

https://api.plixa.app

/v1/ai/preview

requires authentication

Runs the AI provider against the supplied business description and either a single message or a multi-turn conversation. Lets operators iterate on their prompt before flipping the toggle on.

Plan-gated to Professional+ (same guard as production replies) so the playground can't be used as a free LLM proxy. Additionally throttled to 10 requests per minute per tenant.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

prompt

string

required

The business description being tested. Max 4000 characters.

Example:

We're a Brazilian bakery focused on sourdough...

message

string

The customer message to react to. Required when history is not provided. Max 1000 characters.

Example:

Do you ship to Vila Mariana?

history

string[]

Multi-turn conversation. Each entry: { role: "user"|"assistant", content: string }. Must end with a user entry. Max 20 entries.

Auth

Bearer

Headers

Body

{ "prompt": "We're a Brazilian bakery focused on sourdough...", "message": "Do you ship to Vila Mariana?", "history": { "role": "user", "content": "g" } }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/ai/preview" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"prompt\": \"We\'re a Brazilian bakery focused on sourdough...\",
    \"message\": \"Do you ship to Vila Mariana?\",
    \"history\": [
        \"architecto\"
    ]
}"

Generate three reply candidates for a conversation

POST

https://api.plixa.app

/v1/conversations/{conversation}/ai-suggestions

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

conversation

integer

required

Conversation id.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/conversations/42/ai-suggestions" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Update the AI reply configuration

PUT

https://api.plixa.app

/v1/ai-config

requires authentication

Refuses the update with 403 + AI_PLAN_REQUIRED when the active plan doesn't include AI replies (Starter).

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

prompt

string

required

Plain-text description of the business. Max 4000 characters.

Example:

We're a Brazilian bakery focused on sourdough...

enabled

boolean

required

Turn AI replies on or off.

Example:

true

Auth

Bearer

Headers

Body

{ "prompt": "We're a Brazilian bakery focused on sourdough...", "enabled": true }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/ai-config" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"prompt\": \"We\'re a Brazilian bakery focused on sourdough...\",
    \"enabled\": true
}"

POST v1/ai-faqs

POST

https://api.plixa.app

/v1/ai-faqs

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

question

string

required

Must not be greater than 280 characters.

Example:

answer

string

required

Must not be greater than 2000 characters.

Example:

Headers

Body

{ "question": "b", "answer": "n" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/ai-faqs" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"question\": \"b\",
    \"answer\": \"n\"
}"

PUT v1/ai-faqs/{faq}

PUT

https://api.plixa.app

/v1/ai-faqs/{faq}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

faq

string

required

Example:

564

Body Parameters

question

string

required

Must not be greater than 280 characters.

Example:

answer

string

required

Must not be greater than 2000 characters.

Example:

Headers

URL Parameters

Body

{ "question": "b", "answer": "n" }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/ai-faqs/564" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"question\": \"b\",
    \"answer\": \"n\"
}"

DELETE v1/ai-faqs/{faq}

DELETE

https://api.plixa.app

/v1/ai-faqs/{faq}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

faq

string

required

Example:

564

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/ai-faqs/564" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Bulk reorder. Body shape: `{ "ids": [3, 1, 7, .

POST

https://api.plixa.app

/v1/ai-faqs/reorder

..] }`. Position is reassigned based on array order so the frontend can drag- and-drop without sending a full list of (id, position) pairs.

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

ids

integer[]

Example:

[16]

Headers

Body

{ "ids": [ 16 ] }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/ai-faqs/reorder" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ids\": [
        16
    ]
}"

POST v1/ai/improve-prompt

POST

https://api.plixa.app

/v1/ai/improve-prompt

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

prompt

string

required

Must not be greater than 4000 characters.

Example:

Headers

Body

{ "prompt": "b" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/ai/improve-prompt" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"prompt\": \"b\"
}"

API tokens

Personal access tokens used by external integrations (the panel itself uses its own tokens minted at login under the panel name; this controller never returns those). All token names are prefixed with api: server-side so the listing can be filtered cleanly.

Owner-gated AND plan-gated (api_access feature).

Create a new API token

POST

https://api.plixa.app

/v1/api-tokens

requires authentication

The plain-text token is returned ONCE in this response — the panel must surface it for the operator to copy. Subsequent fetches only carry the hashed prefix.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Human label for the token. Up to 60 characters.

Example:

CRM integration

abilities

string[]

required

Subset of {read, write}. At least one required.

Example:

["read","write"]

expires_in_days

integer

Optional expiry in days from now. 1-365.

Example:

Auth

Bearer

Headers

Body

{ "name": "CRM integration", "abilities": [ "read", "write" ], "expires_in_days": 90 }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/api-tokens" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"CRM integration\",
    \"abilities\": [
        \"read\",
        \"write\"
    ],
    \"expires_in_days\": 90
}"

Revoke an API token

DELETE

https://api.plixa.app

/v1/api-tokens/{token}

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

token

integer

required

Token id.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/api-tokens/11" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Account

The signed-in agent's own availability for taking NEW conversations. Self-service: every member manages only their own state here. The owner's read-only view of the whole team lives on the dashboard.

Current user and workspace

GET

https://api.plixa.app

/v1/me

requires authentication

Returns the authenticated user and the workspace (tenant) they belong to. Useful for the panel boot-up: a single call hydrates the session state.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request GET \
    --get "https://api.plixa.app/v1/me" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "user": {
            "id": 1,
            "tenant_id": 1,
            "name": "Lucia Pereira",
            "email": "[email protected]",
            "role": "owner"
        },
        "tenant": {
            "id": 1,
            "name": "Lucia Studios",
            "slug": "lucia-studios-ab12cd",
            "country_code": "BR",
            "timezone": "America/Sao_Paulo",
            "locale": "pt",
            "status": "active"
        }
    },
    "meta": null,
    "errors": null
}

Update the current user's preferences

PATCH

https://api.plixa.app

/v1/me

requires authentication

Only fields the operator can edit on themselves — name, locale. Workspace-level settings (tenant.locale, plan, etc.) live on other endpoints.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

Display name. Max 255 chars.

Example:

Lucia Pereira

locale

string

UI language. One of en, pt-BR, or null to fall back to browser detection.

Example:

pt-BR

Auth

Bearer

Headers

Body

{ "name": "Lucia Pereira", "locale": "pt-BR" }

Received response

Example request:

curl --request PATCH \
    "https://api.plixa.app/v1/me" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Lucia Pereira\",
    \"locale\": \"pt-BR\"
}"

Set whether I'm accepting new conversations

PUT

https://api.plixa.app

/v1/me/availability

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

is_available

boolean

required

Example:

false

Auth

Bearer

Headers

Body

{ "is_available": false }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/me/availability" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"is_available\": false
}"

Presence heartbeat from the open panel

POST

https://api.plixa.app

/v1/me/availability/heartbeat

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/me/availability/heartbeat" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Schedule the workspace for permanent deletion.

POST

https://api.plixa.app

/v1/account/deletion

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

password

string

required

The owner's current password.

Example:

secret-password

Auth

Bearer

Headers

Body

{ "password": "secret-password" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/account/deletion" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"secret-password\"
}"

Cancel a scheduled deletion and restore the workspace.

DELETE

https://api.plixa.app

/v1/account/deletion

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/account/deletion" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Admin — Authentication

Sign-in for Plixa staff. Issues Sanctum tokens owned by the Admin model, resolved on subsequent requests by the AuthenticateAdmin middleware.

POST

https://api.plixa.app

/v1/admin/auth/login

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Must be a valid email address.

Example:

[email protected]

password

string

required

Example:

|]|{+-

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"[email protected]\",
    \"password\": \"|]|{+-\"
}"

POST v1/admin/auth/logout

POST

https://api.plixa.app

/v1/admin/auth/logout

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/auth/logout" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Admin — Email campaigns

Staff-authored marketing blasts sent from the backoffice through the verified Resend sender ([email protected]). Each send is recorded with per-recipient delivery status; every mutation lands in admin_audit_logs.

POST v1/admin/campaigns

POST

https://api.plixa.app

/v1/admin/campaigns

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/campaigns" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Send a one-off test of the composed content to a single address so staff can eyeball the rendered email before blasting the list. Sent synchronously for immediate pass/fail feedback; not persisted.

POST

https://api.plixa.app

/v1/admin/campaigns/test

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/campaigns/test" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

DELETE v1/admin/campaigns/{id}

DELETE

https://api.plixa.app

/v1/admin/campaigns/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the campaign.

Example:

architecto

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/admin/campaigns/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Admin — Knowledge base

Staff CRUD over help articles. Reads bypass the published scope so drafts are editable; every mutation is recorded to admin_audit_logs.

POST v1/admin/kb/articles

POST

https://api.plixa.app

/v1/admin/kb/articles

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/kb/articles" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST v1/admin/kb/images

POST

https://api.plixa.app

/v1/admin/kb/images

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/kb/images" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

PUT v1/admin/kb/articles/{article}

PUT

https://api.plixa.app

/v1/admin/kb/articles/{article}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

article

string

required

The article.

Example:

564

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/admin/kb/articles/564" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

DELETE v1/admin/kb/articles/{article}

DELETE

https://api.plixa.app

/v1/admin/kb/articles/{article}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

article

string

required

The article.

Example:

564

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/admin/kb/articles/564" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Admin — Support

Shared staff canned responses (macros) used to speed up replies. Global to the backoffice team, not tenant-scoped.

POST v1/admin/support/canned-replies

POST

https://api.plixa.app

/v1/admin/support/canned-replies

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/support/canned-replies" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

PATCH v1/admin/support/canned-replies/{cannedReply}

PATCH

https://api.plixa.app

/v1/admin/support/canned-replies/{cannedReply}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

cannedReply

string

required

Example:

564

Headers

URL Parameters

Received response

Example request:

curl --request PATCH \
    "https://api.plixa.app/v1/admin/support/canned-replies/564" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

DELETE v1/admin/support/canned-replies/{cannedReply}

DELETE

https://api.plixa.app

/v1/admin/support/canned-replies/{cannedReply}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

cannedReply

string

required

Example:

564

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/admin/support/canned-replies/564" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST v1/admin/support/tags

POST

https://api.plixa.app

/v1/admin/support/tags

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Must not be greater than 50 characters.

Example:

Headers

Body

{ "name": "b" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/support/tags" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\"
}"

DELETE v1/admin/support/tags/{id}

DELETE

https://api.plixa.app

/v1/admin/support/tags/{id}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the tag.

Example:

architecto

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/admin/support/tags/architecto" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

PUT v1/admin/support/tickets/{ticket}/tags

PUT

https://api.plixa.app

/v1/admin/support/tickets/{ticket}/tags

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

ticket

string

required

The ticket.

Example:

564

Body Parameters

tag_ids

integer[]

The id of an existing record in the support_tags table.

Example:

[16]

Headers

URL Parameters

Body

{ "tag_ids": [ 16 ] }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/admin/support/tickets/564/tags" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"tag_ids\": [
        16
    ]
}"

Heartbeat for ticket presence; returns the other staff viewing it.

POST

https://api.plixa.app

/v1/admin/support/tickets/{ticket}/viewing

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

ticket

string

required

The ticket.

Example:

564

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/support/tickets/564/viewing" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST v1/admin/support/tickets/{ticket}/priority

POST

https://api.plixa.app

/v1/admin/support/tickets/{ticket}/priority

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

ticket

string

required

The ticket.

Example:

564

Body Parameters

priority

string

required

Example:

architecto

Headers

URL Parameters

Body

{ "priority": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/support/tickets/564/priority" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"priority\": \"architecto\"
}"

POST v1/admin/support/tickets/{ticket}/assign

POST

https://api.plixa.app

/v1/admin/support/tickets/{ticket}/assign

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

ticket

string

required

The ticket.

Example:

564

Body Parameters

admin_id

integer

The id of an existing record in the admins table.

Example:

Headers

URL Parameters

Body

{ "admin_id": 16 }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/support/tickets/564/assign" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"admin_id\": 16
}"

POST v1/admin/support/tickets/{ticket}/messages

POST

https://api.plixa.app

/v1/admin/support/tickets/{ticket}/messages

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

ticket

string

required

The ticket.

Example:

564

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/support/tickets/564/messages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST v1/admin/support/tickets/{ticket}/close

POST

https://api.plixa.app

/v1/admin/support/tickets/{ticket}/close

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

ticket

string

required

The ticket.

Example:

564

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/support/tickets/564/close" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST v1/admin/support/tickets/{ticket}/reopen

POST

https://api.plixa.app

/v1/admin/support/tickets/{ticket}/reopen

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

ticket

string

required

The ticket.

Example:

564

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/support/tickets/564/reopen" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Move the ticket through its lifecycle (open / pending / solved / closed).

POST

https://api.plixa.app

/v1/admin/support/tickets/{ticket}/status

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

ticket

string

required

The ticket.

Example:

564

Body Parameters

status

string

required

Example:

architecto

Headers

URL Parameters

Body

{ "status": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/support/tickets/564/status" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"status\": \"architecto\"
}"

Admin — Tenants

Cross-tenant oversight for staff: list every workspace with its plan, usage and status, drill into one, and run the safe lifecycle actions (suspend / reactivate). Every mutation is recorded to admin_audit_logs.

POST v1/admin/tenants/{tenant_id}/suspend

POST

https://api.plixa.app

/v1/admin/tenants/{tenant_id}/suspend

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

tenant_id

integer

required

The ID of the tenant.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/tenants/16/suspend" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST v1/admin/tenants/{tenant_id}/reactivate

POST

https://api.plixa.app

/v1/admin/tenants/{tenant_id}/reactivate

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

tenant_id

integer

required

The ID of the tenant.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/tenants/16/reactivate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Mint a short-lived tenant token so staff can step into a customer's panel to debug. Time-boxed to 30 minutes and recorded to admin_audit_logs — this is a powerful, fully-traceable action.

POST

https://api.plixa.app

/v1/admin/tenants/{tenant_id}/impersonate

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

tenant_id

integer

required

The ID of the tenant.

Example:

Body Parameters

user_id

integer

Example:

Headers

URL Parameters

Body

{ "user_id": 16 }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/tenants/16/impersonate" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"user_id\": 16
}"

Grant a manual, Plixa-issued license — independent of Stripe. Used to comp design partners / beta testers a plan for a custom window (`expires_in_months`) or for life (omit it). Unlocks the plan's features + seats immediately via Tenant::planKey().

POST

https://api.plixa.app

/v1/admin/tenants/{tenant_id}/license

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

tenant_id

integer

required

The ID of the tenant.

Example:

Body Parameters

plan_key

string

required

Example:

architecto

expires_in_months

integer

Must be at least 1. Must not be greater than 120.

Example:

Headers

URL Parameters

Body

{ "plan_key": "architecto", "expires_in_months": 22 }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/tenants/16/license" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"plan_key\": \"architecto\",
    \"expires_in_months\": 22
}"

Revoke a manual license grant — the tenant falls back to Stripe.

DELETE

https://api.plixa.app

/v1/admin/tenants/{tenant_id}/license

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

tenant_id

integer

required

The ID of the tenant.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/admin/tenants/16/license" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Authentication

Register a new workspace

POST

https://api.plixa.app

/v1/auth/register

Creates a Tenant (workspace) and the owner User in a single transaction, then issues a Sanctum bearer token for the owner.

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Full name of the owner.

Example:

Lucia Pereira

string

required

Owner email (lowercased server-side).

Example:

[email protected]

password

string

required

Minimum 8 characters.

Example:

super-secret-pw

company_name

string

required

Workspace display name.

Example:

Lucia Studios

country_code

string

required

ISO 3166-1 alpha-2 country code.

Example:

tax_id

string

Optional local tax ID (CPF/CNPJ/VAT/EIN).

Example:

architecto

timezone

string

Optional IANA timezone. Defaults to UTC.

Example:

America/Sao_Paulo

locale

string

Optional locale: en, pt or es. Defaults to en.

Example:

password_confirmation

string

required

Must match password.

Example:

super-secret-pw

Headers

Body

{ "name": "Lucia Pereira", "email": "[email protected]", "password": "super-secret-pw", "company_name": "Lucia Studios", "country_code": "BR", "tax_id": "architecto", "timezone": "America\/Sao_Paulo", "locale": "pt", "password_confirmation": "super-secret-pw" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/auth/register" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Lucia Pereira\",
    \"email\": \"[email protected]\",
    \"password\": \"super-secret-pw\",
    \"company_name\": \"Lucia Studios\",
    \"country_code\": \"BR\",
    \"tax_id\": \"architecto\",
    \"timezone\": \"America\\/Sao_Paulo\",
    \"locale\": \"pt\",
    \"password_confirmation\": \"super-secret-pw\"
}"

Example response:

{
    "data": {
        "user": {
            "id": 1,
            "tenant_id": 1,
            "name": "Lucia Pereira",
            "email": "[email protected]",
            "role": "owner"
        },
        "tenant": {
            "id": 1,
            "name": "Lucia Studios",
            "slug": "lucia-studios-ab12cd",
            "country_code": "BR",
            "timezone": "America/Sao_Paulo",
            "locale": "pt",
            "status": "active"
        },
        "token": "1|abcdef0123456789"
    },
    "meta": null,
    "errors": null
}

POST

https://api.plixa.app

/v1/auth/login

Returns a Sanctum bearer token on success. Email comparison is case-insensitive. Wrong email and wrong password both return the same 401 with code INVALID_CREDENTIALS — we don't leak user existence.

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Account email.

Example:

[email protected]

password

string

required

Account password.

Example:

super-secret-pw

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/auth/login" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"[email protected]\",
    \"password\": \"super-secret-pw\"
}"

Example response:

{
    "data": {
        "user": {
            "id": 1,
            "tenant_id": 1,
            "name": "Lucia Pereira",
            "email": "[email protected]",
            "role": "owner"
        },
        "tenant": {
            "id": 1,
            "name": "Lucia Studios",
            "slug": "lucia-studios-ab12cd",
            "country_code": "BR",
            "timezone": "America/Sao_Paulo",
            "locale": "pt",
            "status": "active"
        },
        "token": "1|abcdef0123456789"
    },
    "meta": null,
    "errors": null
}

Verify a TOTP or recovery code and complete the login.

POST

https://api.plixa.app

/v1/auth/2fa-challenge

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

code

string

TOTP code from the authenticator app. Pass either this or recovery_code.

Example:

architecto

recovery_code

string

One of the recovery codes generated at setup.

Example:

architecto

Auth

Bearer

Headers

Body

{ "code": "architecto", "recovery_code": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/auth/2fa-challenge" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"architecto\",
    \"recovery_code\": \"architecto\"
}"

Sign out

POST

https://api.plixa.app

/v1/auth/logout

requires authentication

Revokes the token that authenticated this request. Other tokens on the same account keep working (e.g. another device, another integration).

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/auth/logout" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Auto-assignment

Per-workspace routing rules that pick an assignee for brand-new conversations. Listing is open to every member so agents can see why they got assigned; mutation is owner-only and plan-gated.

Create a new auto-assignment rule.

POST

https://api.plixa.app

/v1/auto-assignment-rules

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

priority

integer

required

Lower priority runs first.

Example:

100

condition_type

string

required

One of always|keyword|label.

Example:

keyword

condition_value

string

Required when condition_type is keyword (phrase) or label (label id).

Example:

architecto

action_type

string

required

One of assign_user|round_robin|least_busy.

Example:

least_busy

action_user_id

integer

Required when action_type is assign_user.

Example:

is_active

boolean

Defaults to true.

Example:

false

Auth

Bearer

Headers

Body

{ "priority": 100, "condition_type": "keyword", "condition_value": "architecto", "action_type": "least_busy", "action_user_id": 16, "is_active": false }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/auto-assignment-rules" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"priority\": 100,
    \"condition_type\": \"keyword\",
    \"condition_value\": \"architecto\",
    \"action_type\": \"least_busy\",
    \"action_user_id\": 16,
    \"is_active\": false
}"

Preview which rule (if any) would fire for a hypothetical inbound and who it would route to — without assigning anything or advancing the round-robin cursor. Lets an owner verify rules before they act on real customers.

POST

https://api.plixa.app

/v1/auto-assignment-rules/preview

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

message

string

A sample inbound message body to match keyword rules against.

Example:

I want a refund

label_id

integer

A label id to match label rules against.

Example:

Auth

Bearer

Headers

Body

{ "message": "I want a refund", "label_id": 16 }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/auto-assignment-rules/preview" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"message\": \"I want a refund\",
    \"label_id\": 16
}"

Update an existing auto-assignment rule.

PUT

https://api.plixa.app

/v1/auto-assignment-rules/{rule}

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

rule

string

required

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/auto-assignment-rules/564" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Delete an auto-assignment rule.

DELETE

https://api.plixa.app

/v1/auto-assignment-rules/{rule}

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

rule

string

required

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/auto-assignment-rules/564" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Billing

Start a Stripe Checkout session

POST

https://api.plixa.app

/v1/billing/checkout

requires authentication

Creates a Stripe Checkout Session for the authenticated user's workspace and returns the hosted URL the panel should redirect to. A 7-day free trial is applied to the workspace's first subscription.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

plan

string

required

Plan key — one of "starter", "professional", "business".

Example:

professional

interval

string

Billing cadence — "month" (default) or "year". Annual is billed at 10x the monthly rate.

Example:

year

Auth

Bearer

Headers

Body

{ "plan": "professional", "interval": "year" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/billing/checkout" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"plan\": \"professional\",
    \"interval\": \"year\"
}"

Example response:

{
    "data": {
        "url": "https://checkout.stripe.com/c/pay/cs_test_abc123",
        "plan": "professional",
        "interval": "month"
    },
    "meta": null,
    "errors": null
}

Open the Stripe Customer Portal

POST

https://api.plixa.app

/v1/billing/portal

requires authentication

Returns a one-shot URL that lets the customer update card, change plan, see invoices, or cancel — all without us writing UI for it. The portal must be enabled in Stripe Dashboard → Settings → Billing → Customer portal (test mode and live mode are separate).

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/billing/portal" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

{
    "data": {
        "url": "https://billing.stripe.com/p/session/test_..."
    },
    "meta": null,
    "errors": null
}

Broadcasts

Mass-message campaigns. Owner-only writes, plan-gated to Professional+. Reads (list + detail + recipient breakdown) are open to every member so agents can see what's been sent and to whom.

Create and queue a broadcast.

POST

https://api.plixa.app

/v1/broadcasts

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

Internal name for the broadcast. Up to 100 chars.

Example:

Black Friday 50% off

body

string

required

Message body. {{name}} and {{first_name}} are substituted per recipient. Up to 1024 chars.

Example:

Hi {{first_name}}! 50% off this Friday.

source

string

One of manual (default) or label.

Example:

manual

recipients

string[]

Required when source = manual. Each entry: { phone, name? }. Max 1000.

label_id

integer

Required when source = label.

Example:

scheduled_at

string

Must be a valid date. Must be a date after now.

Example:

2052-07-03

Auth

Bearer

Headers

Body

{ "name": "Black Friday 50% off", "body": "Hi {{first_name}}! 50% off this Friday.", "source": "manual", "recipients": { "phone": "642559314232682282", "name": "u" }, "label_id": 16, "scheduled_at": "2052-07-03" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/broadcasts" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"Black Friday 50% off\",
    \"body\": \"Hi {{first_name}}! 50% off this Friday.\",
    \"source\": \"manual\",
    \"recipients\": [
        \"architecto\"
    ],
    \"label_id\": 16,
    \"scheduled_at\": \"2052-07-03\"
}"

Cancel a broadcast still in flight. Already-sent recipients stay sent; pending ones are marked failed by the worker on the next check.

POST

https://api.plixa.app

/v1/broadcasts/{broadcast}/cancel

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

broadcast

string

required

The broadcast.

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/broadcasts/564/cancel" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Business hours

Per-workspace open/closed schedule. When enabled, inbound messages outside the configured window trigger an auto-reply instead of an AI reply. Available on every plan — closed-hours signalling is a trust feature, not a paywalled extra.

Update the business hours configuration

PUT

https://api.plixa.app

/v1/business-hours-config

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

enabled

boolean

required

Turn the closed-hours auto-reply on or off.

Example:

true

message

string

The auto-reply text sent outside business hours. Up to 500 characters.

Example:

We're closed right now. We'll get back to you in the morning!

hours

string[]

required

Weekly schedule. Exactly 7 entries, weekday 0 (Sunday) to 6 (Saturday). Each entry has open and close in HH:MM and an enabled boolean.

weekday

integer

required

Must be at least 0. Must not be greater than 6.

Example:

open

string

required

Must match the regex /^([0-1]\d.

Example:

(05

string

required

Must match the regex /^([0-1]\d.

Example:

(05

enabled

boolean

required

Example:

true

pause_sla

boolean

Example:

false

Auth

Bearer

Headers

Body

{ "enabled": true, "message": "We're closed right now. We'll get back to you in the morning!", "hours": { "weekday": 4, "open": "(05", "close": "(05", "enabled": true }, "pause_sla": false }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/business-hours-config" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"enabled\": true,
    \"message\": \"We\'re closed right now. We\'ll get back to you in the morning!\",
    \"hours\": [
        \"architecto\"
    ],
    \"pause_sla\": false
}"

CSAT

Post-resolution satisfaction survey. When a conversation is resolved the bot asks the customer to rate it 1-5; a low score optionally asks for a comment. Owner-managed, available on every plan.

Update the CSAT configuration

PUT

https://api.plixa.app

/v1/csat-config

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

enabled

boolean

required

Turn the survey on or off.

Example:

true

question

string

The rating prompt.

Example:

How was your support? Reply 1-5.

follow_up_enabled

boolean

Ask for a comment after a low score (<=3).

Example:

true

follow_up_question

string

The comment prompt.

Example:

What could we improve?

thank_you

string

Optional closing message after a rating.

Example:

Thanks for the feedback!

visible_to_agents

boolean

Example:

true

Auth

Bearer

Headers

Body

{ "enabled": true, "question": "How was your support? Reply 1-5.", "follow_up_enabled": true, "follow_up_question": "What could we improve?", "thank_you": "Thanks for the feedback!", "visible_to_agents": true }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/csat-config" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"enabled\": true,
    \"question\": \"How was your support? Reply 1-5.\",
    \"follow_up_enabled\": true,
    \"follow_up_question\": \"What could we improve?\",
    \"thank_you\": \"Thanks for the feedback!\",
    \"visible_to_agents\": true
}"

Contacts

Tenant-scoped contact directory. Reads are open to every member; writes are owner-gated because notes + field values are visible across the workspace and shouldn't be agent-mutable.

Custom field READS are always permitted (so agents see what the owner configured); only writes to definitions are plan-gated.

Create a contact (or return the existing one for the phone)

POST

https://api.plixa.app

/v1/contacts

requires authentication

Idempotent per (tenant, phone): manual creation from the panel — e.g. booking an appointment for a walk-in who hasn't messaged yet — must not fail when that phone already wrote in. Open to every member because agents legitimately add customers while booking; only field-value writes and deletion stay owner-gated.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

contact_phone

string

required

Plain digits, optional leading +. Stored without the + to match how Evolution returns numbers in @s.whatsapp.net. Must match the regex /^+?\d{8,18}$/.

Example:

642559314232682282

contact_name

string

Must not be greater than 120 characters.

Example:

Auth

Bearer

Headers

Body

{ "contact_phone": "642559314232682282", "contact_name": "u" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/contacts" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contact_phone\": \"642559314232682282\",
    \"contact_name\": \"u\"
}"

Attach a label to the contact

POST

https://api.plixa.app

/v1/contacts/{contact}/labels/{label}

Idempotent: re-attaching is a no-op. Open to every workspace member so agents can tag customers without owner approval.

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contact

string

required

The contact.

Example:

564

label

string

required

The label.

Example:

564

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/contacts/564/labels/564" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Detach a label from the contact

DELETE

https://api.plixa.app

/v1/contacts/{contact}/labels/{label}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contact

string

required

The contact.

Example:

564

label

string

required

The label.

Example:

564

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/contacts/564/labels/564" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Update a contact's editable fields

PATCH

https://api.plixa.app

/v1/contacts/{id}

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the contact.

Example:

architecto

Body Parameters

contact_name

string

Must not be greater than 120 characters.

Example:

notes

string

Must not be greater than 4000 characters.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "contact_name": "b", "notes": "n" }

Received response

Example request:

curl --request PATCH \
    "https://api.plixa.app/v1/contacts/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contact_name\": \"b\",
    \"notes\": \"n\"
}"

Delete a contact

DELETE

https://api.plixa.app

/v1/contacts/{id}

requires authentication

Field values cascade with the contact row. Conversations stay (their contact_id becomes null via the FK on-delete rule); the panel still shows them by phone.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the contact.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/contacts/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Set / clear the contact's custom field values in one shot

PUT

https://api.plixa.app

/v1/contacts/{contact}/custom-fields

requires authentication

Body: { values: { [definition_id]: string|null } }. Empty strings get coerced to null. Unknown definition ids are silently skipped — keeps the panel resilient to an out-of- date list. Owner-only, plan-gated.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

contact

string

required

The contact.

Example:

564

Body Parameters

values

string[]

Must not be greater than 1000 characters.

Example:

["b"]

Auth

Bearer

Headers

URL Parameters

Body

{ "values": [ "b" ] }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/contacts/564/custom-fields" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"values\": [
        \"b\"
    ]
}"

Contacts (custom fields)

Per-tenant schema for the custom fields operators attach to Contact rows. Listing is open to every member (the inbox renders the definitions inline next to the contact's values). Writes are owner-only AND plan-gated (Professional+).

Create a new field definition

POST

https://api.plixa.app

/v1/custom-field-definitions

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/custom-field-definitions" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Update a field definition

PUT

https://api.plixa.app

/v1/custom-field-definitions/{definition}

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

definition

string

required

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/custom-field-definitions/564" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Delete a field definition

DELETE

https://api.plixa.app

/v1/custom-field-definitions/{definition}

requires authentication

Cascades: every value of this field across all contacts is wiped at the database level via the FK on-delete rule.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

definition

string

required

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/custom-field-definitions/564" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Reorder field definitions

POST

https://api.plixa.app

/v1/custom-field-definitions/reorder

requires authentication

Same pattern as saved-replies reorder: ids in the desired top-to-bottom order. Ids from other tenants get silently dropped at the SQL update layer.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

ids

integer[]

Example:

[16]

Auth

Bearer

Headers

Body

{ "ids": [ 16 ] }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/custom-field-definitions/reorder" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ids\": [
        16
    ]
}"

Conversations

Apply an action to many conversations in one request

POST

https://api.plixa.app

/v1/conversations/bulk

requires authentication

Cuts the number of round-trips for operators triaging the inbox. Supported actions: close, reopen, assign, delete, add_label, remove_label. Returns the number of rows actually affected (silently skips ids that don't belong to the tenant — withoutGlobalScope is never applied here).

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

action

string

required

One of close, reopen, assign, delete, add_label, remove_label.

Example:

ids

integer[]

required

Conversation ids to act on. 1-100 per call.

Example:

[12,17,19]

assignee_id

integer

Required when action=assign. Null to unassign.

Example:

label_id

integer

Required when action=add_label or remove_label.

Example:

Auth

Bearer

Headers

Body

{ "action": "close", "ids": [ 12, 17, 19 ], "assignee_id": 7, "label_id": 3 }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/conversations/bulk" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"action\": \"close\",
    \"ids\": [
        12,
        17,
        19
    ],
    \"assignee_id\": 7,
    \"label_id\": 3
}"

Update a conversation

PATCH

https://api.plixa.app

/v1/conversations/{id}

requires authentication

Edit the contact label shown for the conversation. WhatsApp doesn't always send a pushName, so operators need to tag contacts manually.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the conversation.

Example:

architecto

conversation

integer

required

Conversation id.

Example:

Body Parameters

contact_name

string

Friendly label for the contact. Pass empty string to clear.

Example:

Lucia Pereira

notes

string

Must not be greater than 4000 characters.

Example:

assigned_user_id

integer

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "contact_name": "Lucia Pereira", "notes": "n", "assigned_user_id": 16 }

Received response

Example request:

curl --request PATCH \
    "https://api.plixa.app/v1/conversations/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contact_name\": \"Lucia Pereira\",
    \"notes\": \"n\",
    \"assigned_user_id\": 16
}"

Snooze a conversation

POST

https://api.plixa.app

/v1/conversations/{conversation}/snooze

requires authentication

Hides the conversation from the default inbox list until the given timestamp passes. The plixa:wake-snoozed-conversations scheduled command clears the stamp at the right moment and broadcasts a ConversationUpdated so the inbox refreshes without a hard reload. Pass until: null to wake immediately.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

conversation

integer

required

Conversation id.

Example:

Body Parameters

until

string

Optional ISO-8601 timestamp. Null wakes immediately.

Example:

2026-05-29T09:00:00Z

Auth

Bearer

Headers

URL Parameters

Body

{ "until": "2026-05-29T09:00:00Z" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/conversations/42/snooze" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"until\": \"2026-05-29T09:00:00Z\"
}"

POST v1/conversations/{conversation_id}/messages

POST

https://api.plixa.app

/v1/conversations/{conversation_id}/messages

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

conversation_id

string

required

The ID of the conversation.

Example:

architecto

Body Parameters

body

string

required

Must not be greater than 4096 characters.

Example:

type

string

Must be one of:

text
note

Example:

text

quoted_message_id

integer

Optional: reference to a previous message in the same conversation. When the quoted row has an evolution_message_id we relay the WhatsApp-protocol quoted envelope so the customer's phone shows the reply attached to the original bubble. Quotes pointing at internal notes (which never reached WhatsApp) are saved locally but skipped on the outbound payload.

Example:

Headers

URL Parameters

Body

{ "body": "b", "type": "text", "quoted_message_id": 16 }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/conversations/architecto/messages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"body\": \"b\",
    \"type\": \"text\",
    \"quoted_message_id\": 16
}"

Send an outbound media message

POST

https://api.plixa.app

/v1/conversations/{conversation_id}/media-messages

requires authentication

Accepts a multipart upload (image, video, audio, document) plus an optional caption. The file is forwarded to Evolution as base64 — no S3 in MVP, no media URL we host. The resulting Message row stores trimmed metadata so the inbox renders a thumbnail / link inline just like inbound media.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

URL Parameters

conversation_id

string

required

The ID of the conversation.

Example:

architecto

conversation

integer

required

Conversation id.

Example:

Body Parameters

file

required

The file to send. Up to 16 MB.

Example:

/tmp/phpfooGmL

caption

string

Optional caption shown next to the media.

Example:

architecto

voice

boolean

Send as a WhatsApp voice note (PTT) instead of a plain file.

Example:

true

duration_seconds

integer

Recorded length in seconds (used for voice notes).

Example:

waveform

number[]

Must be at least 0. Must not be greater than 255.

Example:

[7]

Auth

Bearer

Headers

URL Parameters

Body

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/conversations/architecto/media-messages" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "caption=architecto"\
    --form "voice=1"\
    --form "duration_seconds=5"\
    --form "waveform[]=7"\
    --form "file=@/tmp/phpfooGmL"

Delete a conversation

DELETE

https://api.plixa.app

/v1/conversations/{id}

requires authentication

Permanently removes a conversation and every message inside it for the authenticated tenant. The contact on the customer's phone is unaffected — only Plixa's local copy goes. Useful while sandbox-testing.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the conversation.

Example:

architecto

conversation

integer

required

Conversation id.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/conversations/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Example response:

[Empty response]

Daily digest

Owner-only toggle for the daily activity email. Off by default; flipping it on enrolls the workspace in tomorrow's 9am UTC run.

Update the daily digest configuration

PUT

https://api.plixa.app

/v1/digest-config

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

enabled

boolean

required

Receive a summary email.

Example:

true

frequency

string

Cadence: daily, weekly (Mondays) or monthly (1st of the month). Defaults to daily.

Example:

weekly

Auth

Bearer

Headers

Body

{ "enabled": true, "frequency": "weekly" }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/digest-config" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"enabled\": true,
    \"frequency\": \"weekly\"
}"

Send a one-off "test" digest to the current authenticated user.

POST

https://api.plixa.app

/v1/digest-config/test

requires authentication

Uses the same stats payload + template as the scheduled job so the operator gets a real preview of what tomorrow's email will look like. Differences from the scheduled run:

Recipient is the CURRENT user, not the owner. (An owner testing from their phone might want it sent to a personal inbox via a copy of the account.)
Empty-activity workspaces still get the email — for a test, the operator wants the layout regardless.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/digest-config/test" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Endpoints

POST v1/ai/extract-business-hours

POST

https://api.plixa.app

/v1/ai/extract-business-hours

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

prompt

string

required

Must not be greater than 4000 characters.

Example:

Headers

Body

{ "prompt": "b" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/ai/extract-business-hours" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"prompt\": \"b\"
}"

Flows

Visual conversation flows: the bot walks an inbound conversation through a graph of steps (greeting, menu, capture, route to a sector, hand off) before the AI or a human takes over. Owner-only — flows are workspace automation, not per-agent settings.

Editing saves a draft; the live graph only changes on Publish, so a half-finished edit never reaches a real customer.

Create a flow

POST

https://api.plixa.app

/v1/flows

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

name

string

required

The flow name.

Example:

WhatsApp reception

draft_definition

object

reprompt_after_minutes

integer

Must be at least 0. Must not be greater than 1440.

Example:

close_after_minutes

integer

Must be at least 0. Must not be greater than 10080.

Example:

reprompt_message

string

Must not be greater than 500 characters.

Example:

close_conversation_on_timeout

boolean

Example:

true

Auth

Bearer

Headers

Body

{ "name": "WhatsApp reception", "draft_definition": null, "reprompt_after_minutes": 22, "close_after_minutes": 7, "reprompt_message": "z", "close_conversation_on_timeout": true }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/flows" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"WhatsApp reception\",
    \"reprompt_after_minutes\": 22,
    \"close_after_minutes\": 7,
    \"reprompt_message\": \"z\",
    \"close_conversation_on_timeout\": true
}"

Save a flow draft

PUT

https://api.plixa.app

/v1/flows/{id}

requires authentication

Persists the working graph without affecting live conversations.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the flow.

Example:

architecto

Body Parameters

name

string

Must not be greater than 80 characters.

Example:

draft_definition

object

reprompt_after_minutes

integer

Must be at least 0. Must not be greater than 1440.

Example:

close_after_minutes

integer

Must be at least 0. Must not be greater than 10080.

Example:

reprompt_message

string

Must not be greater than 500 characters.

Example:

close_conversation_on_timeout

boolean

Example:

true

Auth

Bearer

Headers

URL Parameters

Body

{ "name": "b", "draft_definition": null, "reprompt_after_minutes": 22, "close_after_minutes": 7, "reprompt_message": "z", "close_conversation_on_timeout": true }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/flows/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"name\": \"b\",
    \"reprompt_after_minutes\": 22,
    \"close_after_minutes\": 7,
    \"reprompt_message\": \"z\",
    \"close_conversation_on_timeout\": true
}"

Publish a flow

POST

https://api.plixa.app

/v1/flows/{flow}/publish

requires authentication

Validates the draft graph and copies it into the live definition.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

flow

string

required

The flow.

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/flows/564/publish" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Enable or disable a flow

POST

https://api.plixa.app

/v1/flows/{flow}/toggle

requires authentication

Turning a flow on switches every other flow with the same trigger off, so only one reception flow runs at a time. A flow must be published before it can be enabled.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

flow

string

required

The flow.

Example:

564

Body Parameters

enabled

boolean

required

Example:

true

Auth

Bearer

Headers

URL Parameters

Body

{ "enabled": true }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/flows/564/toggle" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"enabled\": true
}"

Delete a flow

DELETE

https://api.plixa.app

/v1/flows/{id}

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the flow.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/flows/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Build / edit a flow draft via natural language

POST

https://api.plixa.app

/v1/flows/{flow}/ai-build

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

flow

string

required

The flow.

Example:

564

Body Parameters

history

string[]

required

Conversation so far, oldest-first. Each entry: { role: "user"|"assistant", content: string }. Must end with a user entry. Max 30 turns.

graph

object

The current draft to edit. Defaults to the flow's saved draft_definition.

Auth

Bearer

Headers

URL Parameters

Body

{ "history": { "role": "user", "content": "b" }, "graph": { "nodes": null, "edges": null } }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/flows/564/ai-build" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"history\": [
        \"architecto\"
    ],
    \"graph\": []
}"

Inbox

On-demand AI summary of an inbox thread. When an agent takes over a long conversation, this gives them a 3-6-sentence TL;DR so they don't have to scroll through hundreds of messages to ground themselves. Customer never sees the output — operator-facing only.

Plan-gated to the same tier that allows automated AI replies. Cached on the conversation row; the cache invalidates when a new message lands. A ?refresh=1 query param forces regeneration.

Generate or fetch the cached AI summary for a conversation

POST

https://api.plixa.app

/v1/conversations/{conversation}/summary

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

conversation

integer

required

Conversation id.

Example:

Query Parameters

refresh

integer

Pass 1 to force regeneration even when the cache is fresh.

Example:

Auth

Bearer

Headers

URL Parameters

Query Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/conversations/42/summary?refresh=1" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Labels

Workspace-level tags every member can pin onto conversations. Listing is open to every member (the inbox needs to render badges); creating, renaming, recoloring and deleting is owner-only — keeps the palette disciplined.

Attach a label to a conversation

POST

https://api.plixa.app

/v1/conversations/{conversation}/labels/{label}

requires authentication

Any workspace member can attach. Idempotent: re-attaching is a 200 with the same payload, not a duplicate row.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

conversation

string

required

The conversation.

Example:

564

label

string

required

The label.

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/conversations/564/labels/564" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Detach a label from a conversation

DELETE

https://api.plixa.app

/v1/conversations/{conversation}/labels/{label}

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

conversation

string

required

The conversation.

Example:

564

label

string

required

The label.

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/conversations/564/labels/564" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Create a label

POST

https://api.plixa.app

/v1/labels

requires authentication

Owner-only.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/labels" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Update a label

PUT

https://api.plixa.app

/v1/labels/{id}

requires authentication

Owner-only.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the label.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/labels/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Delete a label

DELETE

https://api.plixa.app

/v1/labels/{id}

requires authentication

Owner-only. Also detaches the label from every conversation it's attached to (cascade on conversation_label).

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the label.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/labels/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Messages API

External entry point for sending outbound WhatsApp messages through Plixa. Authenticates via Sanctum personal access token, with the write ability required. Plan-gated to api_access = true.

Looks up the tenant's first connected phone instance and uses it (Plixa MVP only supports one number per workspace anyway). Creates or reopens a conversation for the contact and persists the outbound Message row so the panel renders it just like any other reply.

POST v1/messages/send

POST

https://api.plixa.app

/v1/messages/send

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

phone

string

required

Plain digits, optionally a leading +. Stored without the + to match how Evolution returns numbers in @s.whatsapp.net. Must match the regex /^+?\d{8,18}$/.

Example:

642559314232682282

body

string

required

Must not be greater than 4096 characters.

Example:

Headers

Body

{ "phone": "642559314232682282", "body": "u" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/messages/send" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"phone\": \"642559314232682282\",
    \"body\": \"u\"
}"

Onboarding

Computes the "getting started" checklist the dashboard banner uses to nudge new workspaces through their first-run setup. State is derived from existing tables on the fly — no extra columns, no background jobs to keep in sync. The only persisted bit is whether the owner explicitly dismissed the banner.

POST v1/onboarding/dismiss

POST

https://api.plixa.app

/v1/onboarding/dismiss

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/onboarding/dismiss" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Payments (Stripe Connect)

Owner-only. Connects each workspace's own Stripe account (Express) so booking deposits land there, and surfaces the payments the workspace has received. No API keys: Stripe hosts the onboarding.

Start (or resume) Stripe onboarding — returns a hosted URL to redirect to.

POST

https://api.plixa.app

/v1/payments/connect

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/payments/connect" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

One-time login link to the workspace's Stripe Express dashboard.

POST

https://api.plixa.app

/v1/payments/dashboard-link

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/payments/dashboard-link" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Phone instances

Add a WhatsApp number

POST

https://api.plixa.app

/v1/phone-instances

requires authentication

Owner-only. Provisions a brand-new Evolution instance for the tenant — up to the plan's whatsapp_numbers limit — and returns it in pending_qr state so the panel can immediately show the pairing QR. Rejected with PHONE_NUMBER_LIMIT_REACHED (409) once the plan's allowance is exhausted.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/phone-instances" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Disconnect a phone instance

POST

https://api.plixa.app

/v1/phone-instances/{phone_instance}/disconnect

requires authentication

Logs the WhatsApp session out of Evolution and flips the local status to disconnected. The next pairing will require a fresh QR scan. Owner-only — disconnecting silently mid-day would disrupt the entire workspace.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

phone_instance

string

required

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/phone-instances/564/disconnect" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Restart a phone instance

POST

https://api.plixa.app

/v1/phone-instances/{phone_instance}/restart

requires authentication

Asks Evolution to bounce the connection without unpairing. Useful when the panel shows "disconnected" but the WhatsApp session is still valid upstream and just needs a nudge. Flips the local status to pending_qr so the next QR poll picks up a fresh code.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

phone_instance

string

required

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/phone-instances/564/restart" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Push notifications

Browser-based push subscriptions backed by the W3C Push API + VAPID. The panel registers a service worker, asks the browser for a PushSubscription, and POSTs the endpoint + keys here. Notifications are then routed through the same Laravel queue as our emails.

Register or refresh a push subscription

POST

https://api.plixa.app

/v1/push/subscriptions

requires authentication

Called by the panel right after the browser grants Notifications permission. Endpoint is unique per (user, browser) — the channel upserts so re-subscribing won't create duplicates.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

endpoint

string

required

Must not be greater than 2048 characters.

Example:

keys

object

content_encoding

string

Must not be greater than 32 characters.

Example:

Auth

Bearer

Headers

Body

{ "endpoint": "b", "keys": { "p256dh": "architecto", "auth": "architecto" }, "content_encoding": "n" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/push/subscriptions" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"endpoint\": \"b\",
    \"keys\": {
        \"p256dh\": \"architecto\",
        \"auth\": \"architecto\"
    },
    \"content_encoding\": \"n\"
}"

Remove a push subscription

DELETE

https://api.plixa.app

/v1/push/subscriptions

requires authentication

Called when the user turns notifications off in the panel or when the service worker reports the subscription has been revoked.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

endpoint

string

required

Must not be greater than 2048 characters.

Example:

Auth

Bearer

Headers

Body

{ "endpoint": "b" }

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/push/subscriptions" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"endpoint\": \"b\"
}"

Register or refresh a push subscription

POST

https://api.plixa.app

/v1/admin/push/subscriptions

requires authentication

Called by the panel right after the browser grants Notifications permission. Endpoint is unique per (user, browser) — the channel upserts so re-subscribing won't create duplicates.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

endpoint

string

required

Must not be greater than 2048 characters.

Example:

keys

object

content_encoding

string

Must not be greater than 32 characters.

Example:

Auth

Bearer

Headers

Body

{ "endpoint": "b", "keys": { "p256dh": "architecto", "auth": "architecto" }, "content_encoding": "n" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/admin/push/subscriptions" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"endpoint\": \"b\",
    \"keys\": {
        \"p256dh\": \"architecto\",
        \"auth\": \"architecto\"
    },
    \"content_encoding\": \"n\"
}"

Remove a push subscription

DELETE

https://api.plixa.app

/v1/admin/push/subscriptions

requires authentication

Called when the user turns notifications off in the panel or when the service worker reports the subscription has been revoked.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

endpoint

string

required

Must not be greater than 2048 characters.

Example:

Auth

Bearer

Headers

Body

{ "endpoint": "b" }

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/admin/push/subscriptions" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"endpoint\": \"b\"
}"

SLA targets

Two optional service-level targets per workspace:

first_response_seconds — how long the customer should wait before someone in the workspace answers their first message.
resolution_seconds — how long a conversation should stay open before it gets closed.

NULL on either means "no target set"; the inbox and reports skip the SLA decoration entirely in that case. Each target is capped at 7 days (604800s) — anything longer is hardly an SLA.

Update the workspace SLA targets

PUT

https://api.plixa.app

/v1/sla-config

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

first_response_seconds

integer

Seconds within which the first inbound burst should be answered. Null disables this target. Max 604800 (7 days).

Example:

900

resolution_seconds

integer

Seconds within which a conversation should be closed. Null disables this target. Max 604800 (7 days).

Example:

86400

Auth

Bearer

Headers

Body

{ "first_response_seconds": 900, "resolution_seconds": 86400 }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/sla-config" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"first_response_seconds\": 900,
    \"resolution_seconds\": 86400
}"

Saved replies

Canned messages every workspace member can pick from while composing in the inbox. Visible to every member (no per-user replies in MVP), but only owners can create/edit/delete — keeps the dropdown curated.

Create a saved reply

POST

https://api.plixa.app

/v1/saved-replies

requires authentication

Owner-only.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

label

string

required

Short label shown in the picker. Max 80 chars.

Example:

Hours

body

string

required

The reply body. Max 2000 chars.

Example:

We're open Monday to Saturday 9am-7pm.

Auth

Bearer

Headers

Body

{ "label": "Hours", "body": "We're open Monday to Saturday 9am-7pm." }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/saved-replies" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"Hours\",
    \"body\": \"We\'re open Monday to Saturday 9am-7pm.\"
}"

Update a saved reply

PUT

https://api.plixa.app

/v1/saved-replies/{savedReply}

requires authentication

Owner-only.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

savedReply

string

required

Example:

564

Body Parameters

label

string

required

Must not be greater than 80 characters.

Example:

body

string

required

Must not be greater than 2000 characters.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "label": "b", "body": "n" }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/saved-replies/564" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"label\": \"b\",
    \"body\": \"n\"
}"

Delete a saved reply

DELETE

https://api.plixa.app

/v1/saved-replies/{savedReply}

requires authentication

Owner-only.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

savedReply

string

required

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/saved-replies/564" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Reorder saved replies

POST

https://api.plixa.app

/v1/saved-replies/reorder

requires authentication

Accepts an array of saved-reply ids in the desired display order. Ids missing from the array keep their current position so a partial drag (e.g., reordering 3 out of 30) doesn't trash the rest. Owner-only.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

ids

integer[]

required

Reply ids in the desired top-to-bottom order.

Example:

[12,7,9]

Auth

Bearer

Headers

Body

{ "ids": [ 12, 7, 9 ] }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/saved-replies/reorder" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"ids\": [
        12,
        7,
        9
    ]
}"

Scheduling — appointments

The calendar feed plus staff actions: manual booking, reschedule, cancel, and marking a no-show. All tenant-scoped; open to every member.

Book an appointment manually (staff)

POST

https://api.plixa.app

/v1/scheduling/appointments

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

service_id

integer

required

Example:

start

string

required

Must be a valid date.

Example:

2026-06-10T00:37:58

provider_id

integer

Example:

contact_id

integer

Example:

notes

string

Must not be greater than 2000 characters.

Example:

repeat

string

occurrences

integer

Must be at least 1. Must not be greater than 52.

Example:

Auth

Bearer

Headers

Body

{ "service_id": 16, "start": "2026-06-10T00:37:58", "provider_id": 16, "contact_id": 16, "notes": "n", "repeat": null, "occurrences": 7 }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/scheduling/appointments" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"service_id\": 16,
    \"start\": \"2026-06-10T00:37:58\",
    \"provider_id\": 16,
    \"contact_id\": 16,
    \"notes\": \"n\",
    \"occurrences\": 7
}"

Edit an appointment's basic fields

PATCH

https://api.plixa.app

/v1/scheduling/appointments/{id}

requires authentication

The booking form lets staff create an appointment without a contact (e.g. a slot reserved before the customer is on file). Those fields are otherwise stuck once the appointment exists — there's no generic edit — so this patches them in afterwards. Only the keys actually sent are touched, so the panel can update just the contact.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

integer

required

The ID of the appointment.

Example:

Body Parameters

contact_id

integer

Example:

notes

string

Must not be greater than 2000 characters.

Example:

Auth

Bearer

Headers

URL Parameters

Body

{ "contact_id": 16, "notes": "n" }

Received response

Example request:

curl --request PATCH \
    "https://api.plixa.app/v1/scheduling/appointments/16" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"contact_id\": 16,
    \"notes\": \"n\"
}"

Reschedule an appointment

POST

https://api.plixa.app

/v1/scheduling/appointments/{appointment}/reschedule

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

appointment

integer

required

The appointment.

Example:

564

Body Parameters

start

string

required

Must be a valid date.

Example:

2026-06-10T00:37:58

Auth

Bearer

Headers

URL Parameters

Body

{ "start": "2026-06-10T00:37:58" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/scheduling/appointments/564/reschedule" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"start\": \"2026-06-10T00:37:58\"
}"

Cancel an appointment

POST

https://api.plixa.app

/v1/scheduling/appointments/{appointment}/cancel

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

appointment

integer

required

The appointment.

Example:

564

Body Parameters

reason

string

Must not be greater than 500 characters.

Example:

scope

string

Auth

Bearer

Headers

URL Parameters

Body

{ "reason": "b", "scope": null }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/scheduling/appointments/564/cancel" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"reason\": \"b\"
}"

Mark an appointment as a no-show

POST

https://api.plixa.app

/v1/scheduling/appointments/{appointment}/no-show

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

appointment

integer

required

The appointment.

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/scheduling/appointments/564/no-show" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Mark an appointment as completed (the patient attended)

POST

https://api.plixa.app

/v1/scheduling/appointments/{appointment}/complete

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

appointment

integer

required

The appointment.

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/scheduling/appointments/564/complete" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Mark that the patient has arrived / checked in (waiting to be seen)

POST

https://api.plixa.app

/v1/scheduling/appointments/{appointment}/arrive

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

appointment

integer

required

The appointment.

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/scheduling/appointments/564/arrive" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Create a Stripe Checkout link to collect an appointment's deposit / prepayment. Operational (owner + agent) so a front-desk agent can send the link. Returns 422 when nothing is owed.

POST

https://api.plixa.app

/v1/scheduling/appointments/{appointment}/payment-link

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

appointment

integer

required

The appointment.

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/scheduling/appointments/564/payment-link" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Approve a pending (requested) booking → confirmed, and schedule its reminders. Owner only.

POST

https://api.plixa.app

/v1/scheduling/appointments/{appointment}/approve

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

appointment

integer

required

The appointment.

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/scheduling/appointments/564/approve" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Decline a pending (requested) booking → cancelled. Owner only.

POST

https://api.plixa.app

/v1/scheduling/appointments/{appointment}/decline

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

appointment

integer

required

The appointment.

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/scheduling/appointments/564/decline" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Scheduling — base schedule

The workspace "base" weekly working hours: a template the owner defines once and imports into each provider, instead of typing the same hours for 30 people. Stored as JSON on the tenant; only the weekly open windows (no date overrides). Owner-only.

Replace the workspace base schedule (owner only)

PUT

https://api.plixa.app

/v1/scheduling/default-schedule

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

timezone

string

required

IANA timezone.

Example:

Asia/Yekaterinburg

rules

string[]

required

Weekly open windows ({ weekday, start_time, end_time }).

weekday

integer

required

Must be at least 0. Must not be greater than 6.

Example:

start_time

string

required

Must be a valid date in the format H:i.

Example:

00:37

end_time

string

required

Must be a valid date in the format H:i.

Example:

00:37

Auth

Bearer

Headers

Body

{ "timezone": "Asia\/Yekaterinburg", "rules": { "weekday": 4, "start_time": "00:37", "end_time": "00:37" } }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/scheduling/default-schedule" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"timezone\": \"Asia\\/Yekaterinburg\",
    \"rules\": [
        \"architecto\"
    ]
}"

Scheduling — calendar sync

Per-agent Google Calendar link. Each member connects their own Google account: Plixa writes their appointments to it and reads their free/busy back so outside commitments block Plixa slots. Tokens are encrypted at rest and never returned to the client.

Disconnect the current user's Google Calendar.

POST

https://api.plixa.app

/v1/scheduling/calendar/google/disconnect

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/scheduling/calendar/google/disconnect" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Scheduling — holidays

Owner toggle: import the workspace country's public holidays as closures so the AI never books on them. Enabling (or re-saving) runs a sync now; disabling drops future holiday closures. Owner-only (route group).

Enable or disable holiday blocking

PUT

https://api.plixa.app

/v1/scheduling/holiday-config

requires authentication

Enabling imports holidays immediately; a network hiccup still saves the toggle (synced=false) and the scheduled sync retries later.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

block_holidays

boolean

required

Whether to block public holidays.

Example:

false

Auth

Bearer

Headers

Body

{ "block_holidays": false }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/scheduling/holiday-config" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"block_holidays\": false
}"

Scheduling — provider availability

A provider's bookable working hours: a timezone plus a flat list of rules (recurring weekday windows and date overrides, open or blocked). Readable by members; the full-replace update is owner-only.

Replace a provider's schedule (owner only)

PUT

https://api.plixa.app

/v1/scheduling/providers/{user}/schedule

requires authentication

Sends the full set of rules; the previous rules are replaced wholesale.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

user

string

required

Example:

564

Body Parameters

timezone

string

required

Must not be greater than 64 characters.

Example:

Asia/Yekaterinburg

rules

object[]

Must not have more than 200 items.

kind

string

required

Example:

architecto

weekday

integer

Must be at least 0. Must not be greater than 6.

Example:

date

string

Must be a valid date in the format Y-m-d.

Example:

2026-06-10

start_time

string

required

Must be a valid date in the format H:i.

Example:

00:37

end_time

string

required

Must be a valid date in the format H:i.

Example:

00:37

Auth

Bearer

Headers

URL Parameters

Body

{ "timezone": "Asia\/Yekaterinburg", "rules": [ { "kind": "architecto", "weekday": 4, "date": "2026-06-10", "start_time": "00:37", "end_time": "00:37" } ] }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/scheduling/providers/564/schedule" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"timezone\": \"Asia\\/Yekaterinburg\",
    \"rules\": [
        {
            \"kind\": \"architecto\",
            \"weekday\": 4,
            \"date\": \"2026-06-10\",
            \"start_time\": \"00:37\",
            \"end_time\": \"00:37\"
        }
    ]
}"

Scheduling — reminders

Owner setting: when the workspace sends appointment reminders, as a list of "minutes before the appointment". Null falls back to the system default; an empty list turns reminders off. A service can still override per-service. Owner-only (route group).

Set the workspace's reminder timing

PUT

https://api.plixa.app

/v1/scheduling/reminder-config

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

offsets

integer[]

required

Minutes before the appointment to remind (empty = off).

Example:

[16]

Auth

Bearer

Headers

Body

{ "offsets": [ 16 ] }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/scheduling/reminder-config" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"offsets\": [
        16
    ]
}"

Scheduling — resources

Shared, capacity-limited assets (rooms, equipment). A booking of a linked service consumes one unit; the slot is full once capacity is reached. Readable by members; mutations owner-only.

Create a resource (owner only)

POST

https://api.plixa.app

/v1/scheduling/resources

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/scheduling/resources" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Update a resource (owner only)

PUT

https://api.plixa.app

/v1/scheduling/resources/{id}

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the resource.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/scheduling/resources/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Delete a resource (owner only)

DELETE

https://api.plixa.app

/v1/scheduling/resources/{id}

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the resource.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/scheduling/resources/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Scheduling — saved filters

Per-user saved calendar filters: which providers, services and statuses to show on the agenda. Each person manages their own; one can be the default, applied automatically when they open the calendar. Every member (not just owners) keeps their own set.

Save a new filter

POST

https://api.plixa.app

/v1/scheduling/calendar-filters

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/scheduling/calendar-filters" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Update a saved filter

PUT

https://api.plixa.app

/v1/scheduling/calendar-filters/{filter}

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

filter

string

required

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/scheduling/calendar-filters/564" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Delete a saved filter

DELETE

https://api.plixa.app

/v1/scheduling/calendar-filters/{filter}

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

filter

string

required

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/scheduling/calendar-filters/564" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Scheduling — services

Bookable services. Readable by every member (the calendar + booking flows need them); create/update/delete are owner-only.

Create a service (owner only)

POST

https://api.plixa.app

/v1/scheduling/services

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/scheduling/services" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Update a service (owner only)

PUT

https://api.plixa.app

/v1/scheduling/services/{id}

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the service.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/scheduling/services/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Delete a service (owner only)

DELETE

https://api.plixa.app

/v1/scheduling/services/{id}

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the service.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/scheduling/services/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Scheduling — waitlist

Surfaces the appointment waitlist (built up by the AI when no slots are free) so staff can see who's waiting for which service and clear stale entries. Tenant-scoped; open to every member. The auto-notify-on-cancel flow lives in NativeSchedulingProvider — this is the human-facing view.

Remove a waitlist entry

DELETE

https://api.plixa.app

/v1/scheduling/waitlist/{entry_id}

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

entry_id

integer

required

The ID of the entry.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/scheduling/waitlist/16" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Scheduling — workspace closures

Days the whole workspace is closed. Adding one date blocks every provider (and the AI) for that day, so the owner closes the business once instead of editing each provider's schedule. Reads are open to members; create/delete are owner-only (route group).

Close the workspace on a date (owner only)

POST

https://api.plixa.app

/v1/scheduling/closures

requires authentication

Idempotent per (tenant, date): re-closing an already-closed day just returns it. Manual source — a holiday sync owns its own rows.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

date

string

required

Must be a valid date in the format Y-m-d.

Example:

2026-06-10

reason

string

Must not be greater than 255 characters.

Example:

Auth

Bearer

Headers

Body

{ "date": "2026-06-10", "reason": "b" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/scheduling/closures" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"date\": \"2026-06-10\",
    \"reason\": \"b\"
}"

Reopen the workspace on a date (owner only)

DELETE

https://api.plixa.app

/v1/scheduling/closures/{id}

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the closure.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/scheduling/closures/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Sectors

Business departments (Sales, Support, Finance…) the owner defines so conversations can be routed to the right team. Listing is open to every member (the inbox and the flow editor both need it); creating, renaming and assigning agents is owner-only.

Create a sector

POST

https://api.plixa.app

/v1/sectors

requires authentication

Owner-only.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/sectors" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Update a sector

PUT

https://api.plixa.app

/v1/sectors/{id}

requires authentication

Owner-only. Pass user_ids to replace the assigned agents.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the sector.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/sectors/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Delete a sector

DELETE

https://api.plixa.app

/v1/sectors/{id}

requires authentication

Owner-only. Conversations tagged with this sector keep their history but lose the tag (sector_id is set to null).

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the sector.

Example:

architecto

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/sectors/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Security

Workspace-wide security / access toggles:

require_two_factor — every member must enable 2FA before the panel grants access.
agent_restricted_to_own_conversations — agents see only their own + unassigned conversations in the inbox. Off by default (matches the helpdesk industry pattern of a shared inbox); on is the multi-team / compliance choice.

Update the workspace security configuration

PUT

https://api.plixa.app

/v1/security-config

requires authentication

Toggling require_two_factor ON is gated on the owner having their own 2FA enabled — otherwise the owner could lock themselves out instantly. Turning it OFF has no such gate.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

require_two_factor

boolean

When true, every member must enable 2FA before the panel grants access.

Example:

true

agent_restricted_to_own_conversations

boolean

When true, agents see only conversations assigned to themselves or unassigned. Owners always see all.

Example:

false

Auth

Bearer

Headers

Body

{ "require_two_factor": true, "agent_restricted_to_own_conversations": false }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/security-config" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"require_two_factor\": true,
    \"agent_restricted_to_own_conversations\": false
}"

Support

The customer side of in-app support: a workspace member opens a ticket and converses with Plixa staff. Auto-scoped to the caller's tenant by the BelongsToTenant global scope on SupportTicket.

POST v1/support/tickets

POST

https://api.plixa.app

/v1/support/tickets

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/support/tickets" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST v1/support/tickets/{ticket_id}/messages

POST

https://api.plixa.app

/v1/support/tickets/{ticket_id}/messages

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

ticket_id

integer

required

The ID of the ticket.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/support/tickets/16/messages" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST v1/support/tickets/{ticket_id}/close

POST

https://api.plixa.app

/v1/support/tickets/{ticket_id}/close

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

ticket_id

integer

required

The ID of the ticket.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/support/tickets/16/close" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

POST v1/support/tickets/{ticket_id}/reopen

POST

https://api.plixa.app

/v1/support/tickets/{ticket_id}/reopen

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

ticket_id

integer

required

The ID of the ticket.

Example:

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/support/tickets/16/reopen" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Customer satisfaction rating — only once the ticket is solved/closed.

POST

https://api.plixa.app

/v1/support/tickets/{ticket_id}/rating

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

ticket_id

integer

required

The ID of the ticket.

Example:

Body Parameters

rating

integer

required

Must be at least 1. Must not be greater than 5.

Example:

comment

string

Must not be greater than 1000 characters.

Example:

Headers

URL Parameters

Body

{ "rating": 1, "comment": "n" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/support/tickets/16/rating" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"rating\": 1,
    \"comment\": \"n\"
}"

Team

Create an invitation

POST

https://api.plixa.app

/v1/team/invitations

requires authentication

Owner-only. Returns the freshly issued invitation including the one-shot accept_url so the panel can render a copy-to-clipboard button. After the response the token is hidden — losing it means re-issuing the invite.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Person being invited.

Example:

[email protected]

role

string

Optional role (defaults to agent).

Example:

agent

Auth

Bearer

Headers

Body

{ "email": "[email protected]", "role": "agent" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/team/invitations" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"[email protected]\",
    \"role\": \"agent\"
}"

Resend the invitation email

POST

https://api.plixa.app

/v1/team/invitations/{invitation}/resend

requires authentication

Owner-only. Queues the same InvitationCreated mailable that the initial create() does — same accept_url, same expiry. Returns the invitation with the link so the owner can also copy-paste it to another channel.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

invitation

integer

required

Invitation id.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/team/invitations/14/resend" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Cancel a pending invitation

DELETE

https://api.plixa.app

/v1/team/invitations/{id}

requires authentication

Owner-only. Accepted invitations cannot be cancelled — remove the user from the workspace instead via MemberController::destroy.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the invitation.

Example:

architecto

invitation

integer

required

Invitation id.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/team/invitations/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Remove a member

DELETE

https://api.plixa.app

/v1/team/members/{id}

requires authentication

Owner-only. Unassigns any conversations that were attached to the removed user (their messages stay). Owners can't remove themselves — they should transfer ownership first (out of MVP scope).

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

string

required

The ID of the member.

Example:

architecto

member

integer

required

The user id.

Example:

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/team/members/architecto" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Accept an invitation

POST

https://api.plixa.app

/v1/team/invitations/accept

Public — creates the user, attaches them to the tenant, marks the invitation accepted, and returns a Sanctum token so the panel can sign them in immediately.

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

token

string

required

Invitation token.

Example:

aBcD1234…

name

string

required

Display name.

Example:

Lucia Pereira

password

string

required

Min 8 characters.

Example:

super-secret-pw

Headers

Body

{ "token": "aBcD1234\u2026", "name": "Lucia Pereira", "password": "super-secret-pw" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/team/invitations/accept" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"token\": \"aBcD1234…\",
    \"name\": \"Lucia Pereira\",
    \"password\": \"super-secret-pw\"
}"

Two-factor authentication

Endpoints the user hits from /account to set up, confirm, regenerate recovery codes for, and disable their own TOTP second factor. All mutations require the current password — defence in depth against stolen session tokens.

Layout:

GET /v1/me/2fa → status (enabled, configured-but-not-confirmed)
POST /v1/me/2fa/setup → mint a fresh secret + otpauth URL
POST /v1/me/2fa/confirm → verify first code, return recovery codes
POST /v1/me/2fa/recovery-codes → regenerate recovery codes
DELETE /v1/me/2fa → disable 2FA entirely

POST v1/me/2fa/setup

POST

https://api.plixa.app

/v1/me/2fa/setup

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

password

string

required

Example:

|]|{+-

Headers

Body

{ "password": "|]|{+-" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/me/2fa/setup" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"|]|{+-\"
}"

POST v1/me/2fa/confirm

POST

https://api.plixa.app

/v1/me/2fa/confirm

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

code

string

required

Example:

architecto

Headers

Body

{ "code": "architecto" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/me/2fa/confirm" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"code\": \"architecto\"
}"

POST v1/me/2fa/recovery-codes

POST

https://api.plixa.app

/v1/me/2fa/recovery-codes

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

password

string

required

Example:

|]|{+-

Headers

Body

{ "password": "|]|{+-" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/me/2fa/recovery-codes" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"|]|{+-\"
}"

Revoke a single recovery code

POST

https://api.plixa.app

/v1/me/2fa/recovery-codes/revoke

requires authentication

For when an operator suspects ONE code leaked (left a printout somewhere, sent it in a Slack DM by mistake) but wants to keep the others valid instead of regenerating the whole list.

Password-gated, audit-logged. Returns the count of remaining codes — the panel uses it to surface "you have N codes left".

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

password

string

required

Current account password.

Example:

********

code

string

required

The recovery code to revoke.

Example:

a1b2c3d4e5

Auth

Bearer

Headers

Body

{ "password": "********", "code": "a1b2c3d4e5" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/me/2fa/recovery-codes/revoke" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"********\",
    \"code\": \"a1b2c3d4e5\"
}"

DELETE v1/me/2fa

DELETE

https://api.plixa.app

/v1/me/2fa

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

password

string

required

Example:

|]|{+-

Headers

Body

{ "password": "|]|{+-" }

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/me/2fa" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"password\": \"|]|{+-\"
}"

Waitlist

Join the public waitlist

POST

https://api.plixa.app

/v1/waitlist

Stores an email for early access. Plixa never sells this list. The landing page (plixa.app) posts here from its hero and footer forms.

Headers

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

string

required

Email to add to the waitlist. Lowercased server-side.

Example:

[email protected]

locale

string

Optional browser locale (BCP-47).

Example:

en-US

referrer

string

Optional URL that referred the visitor.

Example:

https://news.ycombinator.com/

Headers

Body

{ "email": "[email protected]", "locale": "en-US", "referrer": "https:\/\/news.ycombinator.com\/" }

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/waitlist" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"email\": \"[email protected]\",
    \"locale\": \"en-US\",
    \"referrer\": \"https:\\/\\/news.ycombinator.com\\/\"
}"

Example response:

{
    "data": {
        "id": 42,
        "email": "[email protected]",
        "created_at": "2026-05-25T12:00:00+00:00"
    },
    "meta": null,
    "errors": null
}

Webhooks

Handle a Stripe webhook call.

POST

https://api.plixa.app

/v1/webhooks/stripe

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/webhooks/stripe" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Webhooks (outbound)

Owner-only management of customer-facing webhook endpoints. Plixa fires message.{inbound,outbound} and conversation.{created, updated,deleted} to every active subscribed endpoint, signed with HMAC-SHA256 (X-Plixa-Signature).

The endpoint secret is shown ONCE at create time. Storage is encrypted, the API never echoes it back — operators who lose the secret rotate the endpoint instead.

POST v1/webhook-endpoints

POST

https://api.plixa.app

/v1/webhook-endpoints

Headers

Content-Type

Example:

application/json

Example:

application/json

Headers

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/webhook-endpoints" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

PUT v1/webhook-endpoints/{endpoint}

PUT

https://api.plixa.app

/v1/webhook-endpoints/{endpoint}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

endpoint

string

required

Example:

564

Headers

URL Parameters

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/webhook-endpoints/564" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

DELETE v1/webhook-endpoints/{endpoint}

DELETE

https://api.plixa.app

/v1/webhook-endpoints/{endpoint}

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

endpoint

string

required

Example:

564

Headers

URL Parameters

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/webhook-endpoints/564" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Fire a synthetic `webhook.test` delivery so the operator can verify their receiver wiring without waiting for a real message.

POST

https://api.plixa.app

/v1/webhook-endpoints/{endpoint}/test

Headers

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

endpoint

string

required

Example:

564

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/webhook-endpoints/564/test" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Re-fire a previously-failed delivery

POST

https://api.plixa.app

/v1/webhook-deliveries/{delivery}/retry

requires authentication

Resets the delivery back to pending, zeroes the attempts counter so the existing exponential-backoff schedule starts fresh, and queues a new DeliverWebhookJob with the same payload. Useful after an operator fixes the receiver — they don't have to wait for another organic event to confirm.

Refuses to act on deliveries that aren't in a terminal failed state (no point retrying a pending one — the job already has it).

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

URL Parameters

delivery

string

required

Example:

564

Auth

Bearer

Headers

URL Parameters

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/webhook-deliveries/564/retry" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Welcome message

Owner-defined greeting auto-sent the first time a contact reaches the workspace. Unlike the AI configuration, this is available on every plan — no plan gate.

Update the welcome message configuration

PUT

https://api.plixa.app

/v1/welcome-config

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

message

string

The greeting to send on first contact. Up to 1000 characters.

Example:

Hi! Thanks for reaching out — we usually reply within 15 minutes.

enabled

boolean

Turn the welcome message on or off.

Example:

true

delay_seconds

integer

Optional wait before the welcome fires. 0-300. Defaults to 0 (immediate).

Example:

Auth

Bearer

Headers

Body

{ "message": "Hi! Thanks for reaching out \u2014 we usually reply within 15 minutes.", "enabled": true, "delay_seconds": 5 }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/welcome-config" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"message\": \"Hi! Thanks for reaching out — we usually reply within 15 minutes.\",
    \"enabled\": true,
    \"delay_seconds\": 5
}"

Workspace configuration

Tenant-wide settings every member is bound to:

timezone (IANA, e.g. America/Sao_Paulo). All scheduled features (business hours, digests, SLA windows, "today" rollups) anchor to THIS — never to the server fuso or the operator's browser.
default locale (en | pt-BR | es). Used as the fallback UI language for members who haven't set their own in /account, and as the language for transactional emails the workspace sends.

Owner-only. Members see their personal locale override in /account.

Update the workspace timezone + default locale + currency

PUT

https://api.plixa.app

/v1/workspace-config

requires authentication

Owner-only. The timezone field accepts only real IANA identifiers (validated against DateTimeZone::listIdentifiers) so a typo can't silently corrupt every scheduled feature.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Body Parameters

timezone

string

required

IANA timezone (e.g. America/Sao_Paulo).

Example:

Asia/Yekaterinburg

locale

string

required

One of en, pt-BR, or es.

Example:

sr_BA

currency

string

required

Example:

architecto

Auth

Bearer

Headers

Body

{ "timezone": "Asia\/Yekaterinburg", "locale": "sr_BA", "currency": "architecto" }

Received response

Example request:

curl --request PUT \
    "https://api.plixa.app/v1/workspace-config" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json" \
    --data "{
    \"timezone\": \"Asia\\/Yekaterinburg\",
    \"locale\": \"sr_BA\",
    \"currency\": \"architecto\"
}"

Upload (or replace) the workspace logo

POST

https://api.plixa.app

/v1/workspace-config/logo

requires authentication

Owner-only. Stored on the shared public-image disk under a UUID key. PNG/JPEG/WebP, ≤ 1 MB — no SVG (XSS surface). Display size is enforced by the consumers (a fixed-height box), so any aspect ratio is fine.

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

multipart/form-data

Example:

application/json

Body Parameters

logo

file

required

Must be a file. Must not be greater than 1024 kilobytes.

Example:

/tmp/phpEBNBMg

Auth

Bearer

Headers

Body

Received response

Example request:

curl --request POST \
    "https://api.plixa.app/v1/workspace-config/logo" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: multipart/form-data" \
    --header "Accept: application/json" \
    --form "logo=@/tmp/phpEBNBMg"

Remove the workspace logo. Owner-only.

DELETE

https://api.plixa.app

/v1/workspace-config/logo

requires authentication

Headers

Authorization

Example:

Bearer {PLIXA_API_TOKEN}

Content-Type

Example:

application/json

Example:

application/json

Auth

Bearer

Headers

Received response

Example request:

curl --request DELETE \
    "https://api.plixa.app/v1/workspace-config/logo" \
    --header "Authorization: Bearer {PLIXA_API_TOKEN}" \
    --header "Content-Type: application/json" \
    --header "Accept: application/json"

Plixa API

Plixa API

Introduction

Quickstart

Response envelope

Rate limits

Webhooks

Authenticating requests

AI configuration

Preview an AI reply without sending anything

Headers

Body Parameters

Generate three reply candidates for a conversation

Headers

URL Parameters

Update the AI reply configuration

Headers

Body Parameters

POST v1/ai-faqs

Headers

Body Parameters

PUT v1/ai-faqs/{faq}

Headers

URL Parameters

Body Parameters

DELETE v1/ai-faqs/{faq}

Headers

URL Parameters

Bulk reorder. Body shape: `{ "ids": [3, 1, 7, .

Headers

Body Parameters

POST v1/ai/improve-prompt

Headers

Body Parameters

API tokens

Create a new API token

Headers

Body Parameters

Revoke an API token

Headers

URL Parameters

Account

Current user and workspace

Headers

Update the current user's preferences

Headers

Body Parameters

Set whether I'm accepting new conversations

Headers

Body Parameters

Presence heartbeat from the open panel

Headers

Schedule the workspace for permanent deletion.

Headers

Body Parameters

Cancel a scheduled deletion and restore the workspace.

Headers

Admin — Authentication

POST v1/admin/auth/login

Headers

Body Parameters

POST v1/admin/auth/logout

Headers

Admin — Email campaigns

POST v1/admin/campaigns

Headers

Send a one-off test of the composed content to a single address so staff can eyeball the rendered email before blasting the list. Sent synchronously for immediate pass/fail feedback; not persisted.

Headers

DELETE v1/admin/campaigns/{id}

Headers

URL Parameters

Admin — Knowledge base

POST v1/admin/kb/articles

Headers

POST v1/admin/kb/images

Headers

PUT v1/admin/kb/articles/{article}

Headers

URL Parameters

DELETE v1/admin/kb/articles/{article}