Developers — AwnCare

Conventions

Consistent base URL, authentication, and response envelope across every endpoint.

Base URL

All endpoints are relative to the versioned base URL.

text

https://awn.care/api/v1

Authentication

Authenticate with an API key created in the Developer Console, passed in the x-api-key header. An API key acts with workspace-admin scope.

bash

curl https://awn.care/api/v1/conversations \
  -H "x-api-key: YOUR_API_KEY"

Keep keys secret

Treat API keys like passwords. Use them only from server-side code — never expose a key in a browser or mobile app.

Response envelope

Successful responses wrap the payload in a consistent envelope.

json

{
  "success": true,
  "data": { /* resource or array */ }
}

List endpoints that paginate add a pagination object.

json

{
  "success": true,
  "data": [ /* … */ ],
  "pagination": {
    "page": 1,
    "perPage": 25,
    "total": 128,
    "totalPages": 6
  }
}

Errors return success: false with a human-readable message and an appropriate HTTP status.

json

{
  "success": false,
  "error": "Invalid API key"
}

Pagination is not uniform: most lists use page and per_page, but tickets use page and pageSize, and some lists (faqs, categories, departments, saved-replies) return a plain array.

Conversations

List, read, update, and delete conversations, and read or send messages within them.

GET/conversations

List conversations in the workspace, newest activity first. Paginated.

Query parameters

Field	Type	Description
`status`	`string`	Filter by conversation status (e.g. OPEN, CLOSED).
`agent_id`	`string`	Filter by assigned agent; pass "unassigned" for none.
`department_id`	`string`	Filter by department.
`search`	`string`	Match subject, visitor name/email, or message content.
`page`	`number`	Page number (default 1).
`per_page`	`number`	Items per page (default 25, max 100).

Request

bash

curl "https://awn.care/api/v1/conversations?status=OPEN&per_page=25" \
  -H "x-api-key: YOUR_API_KEY"

Response

json

{
  "success": true,
  "data": [
    {
      "id": "cnv_8f2a…",
      "subject": "Refund for order #1043",
      "status": "OPEN",
      "channel": "CHAT",
      "priority": "NORMAL",
      "agentId": "usr_agent_1",
      "departmentId": "dep_2",
      "lastMessageAt": "2026-07-31T09:12:44.000Z",
      "visitor": { "id": "vis_1", "name": "Sara", "email": "[email protected]", "online": true },
      "agent": { "id": "usr_agent_1", "name": "Mona", "email": "[email protected]" },
      "department": { "id": "dep_2", "nameAr": "المبيعات", "nameEn": "Sales" },
      "messages": [ { "id": "msg_9", "content": "Any update?", "type": "TEXT" } ]
    }
  ],
  "pagination": { "page": 1, "perPage": 25, "total": 128, "totalPages": 6 }
}

POST/conversations

Create a conversation for a visitor. An agent is auto-assigned by the routing engine when available.

Body

Field	Type	Description
`visitorId`Required	`string`	Id of the visitor the conversation belongs to.
`departmentId`	`string`	Optional department to route to.
`subject`	`string`	Optional conversation subject.
`channel`	`string`	Origin channel (default CHAT).

Request

bash

curl -X POST https://awn.care/api/v1/conversations \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "visitorId": "vis_1",
    "departmentId": "dep_2",
    "subject": "Refund for order #1043",
    "channel": "CHAT"
  }'

GET/conversations/{id}

Retrieve a single conversation with its visitor, agent, department, and tags.

Request

bash

curl https://awn.care/api/v1/conversations/cnv_8f2a \
  -H "x-api-key: YOUR_API_KEY"

PATCH/conversations/{id}

Update a conversation's status, assignee, department, subject, priority, or metadata.

Body

Field	Type	Description
`status`	`string`	New status for the conversation.
`agentId`	`string \| null`	Assign to an agent, or null to unassign.
`departmentId`	`string \| null`	Optional department to route to.
`subject`	`string \| null`	Optional conversation subject.
`priority`	`string`	Conversation priority.
`metadata`	`object`	Arbitrary metadata object.

Request

bash

curl -X PATCH https://awn.care/api/v1/conversations/cnv_8f2a \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "status": "CLOSED", "agentId": "usr_agent_1", "priority": "HIGH" }'

DELETE/conversations/{id}

Soft-delete a conversation (moves to Trash). Deleting one already in Trash removes it permanently.

Request

bash

curl -X DELETE https://awn.care/api/v1/conversations/cnv_8f2a \
  -H "x-api-key: YOUR_API_KEY"

Response

json

{ "success": true, "data": { "deleted": true, "permanent": false } }

GET/conversations/{id}/messages

List messages in a conversation, oldest first. Paginated.

Query parameters

Field	Type	Description
`page`	`number`	Page number (default 1).
`per_page`	`number`	Items per page (default 25, max 100).

Request

bash

curl "https://awn.care/api/v1/conversations/cnv_8f2a/messages?per_page=50" \
  -H "x-api-key: YOUR_API_KEY"

POST/conversations/{id}/messages

Send a message into a conversation. Requires content, attachments, or a RICH type.

Body

Field	Type	Description
`content`	`string`	Message text. Required unless attachments or a RICH type are given.
`type`	`"TEXT" \| "NOTE" \| "RICH" \| "FILE"`	Message type. NOTE is an internal, agents-only note.
`attachments`	`array`	Array of file attachments.
`replyToId`	`string`	Id of the message this replies to.
`metadata`	`object`	Arbitrary metadata object.

Request

bash

curl -X POST https://awn.care/api/v1/conversations/cnv_8f2a/messages \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "content": "تم اعتماد استرداد مبلغك.", "type": "TEXT" }'

Response

json

{
  "success": true,
  "data": {
    "id": "msg_10",
    "conversationId": "cnv_8f2a",
    "content": "تم اعتماد استرداد مبلغك.",
    "type": "TEXT",
    "userId": "api",
    "createdAt": "2026-07-31T09:20:00.000Z",
    "user": { "id": "api", "name": "API", "role": "ADMIN" }
  }
}

Tickets

A full ticketing surface: list, create, read the 360 view, update, and comment.

Ticket endpoints require an agent, supervisor, or admin. API keys always pass this check.

GET/tickets

List tickets, most recently updated first. Note: uses page and pageSize (not per_page).

Query parameters

Field	Type	Description
`status`	`string`	Filter by status. Comma-separated list allowed (e.g. OPEN,PENDING).
`priority`	`string`	Filter by priority (LOW, NORMAL, HIGH, URGENT).
`assigneeId`	`string`	Filter by assignee; "me" for yourself, "unassigned" for none.
`requesterId`	`string`	Filter by requester id.
`q`	`string`	Match subject text or ticket number.
`page`	`number`	Page number (default 1).
`pageSize`	`number`	Items per page (default 25, max 100).

Request

bash

curl "https://awn.care/api/v1/tickets?status=OPEN,PENDING&priority=HIGH&page=1&pageSize=25" \
  -H "x-api-key: YOUR_API_KEY"

Response

json

{
  "success": true,
  "data": {
    "tickets": [
      {
        "id": "tkt_5",
        "number": 1043,
        "subject": "Cannot log in",
        "status": "OPEN",
        "priority": "HIGH",
        "type": "INCIDENT",
        "requester": { "id": "vis_1", "name": "Sara", "email": "[email protected]" },
        "assignee": { "id": "usr_agent_1", "name": "Mona" },
        "department": { "id": "dep_1", "nameAr": "الدعم", "nameEn": "Support" },
        "_count": { "comments": 3 }
      }
    ],
    "total": 42,
    "page": 1,
    "pageSize": 25
  }
}

POST/tickets

Create a ticket. The requester must be a contact in the workspace.

Body

Field	Type	Description
`subject`Required	`string (1–500)`	Ticket subject, 1–500 characters.
`description`Required	`string`	The ticket body.
`requesterId`Required	`string`	Id of the requesting contact (VISITOR, LEAD, or USER).
`priority`	`"LOW" \| "NORMAL" \| "HIGH" \| "URGENT"`	Ticket priority.
`type`	`"QUESTION" \| "INCIDENT" \| "PROBLEM" \| "TASK"`	Ticket type.
`departmentId`	`string \| null`	Optional department to route to.
`assigneeId`	`string \| null`	Optional agent to assign.
`tags`	`string[] (max 50)`	Up to 50 free-form tags.

Request

bash

curl -X POST https://awn.care/api/v1/tickets \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "subject": "Cannot log in",
    "description": "Getting a 500 error on sign-in since this morning.",
    "requesterId": "vis_1",
    "priority": "HIGH",
    "type": "INCIDENT",
    "tags": ["auth", "urgent"]
  }'

GET/tickets/{id}

Retrieve a ticket with its comments, events, and requester context (other tickets and conversations).

Request

bash

curl https://awn.care/api/v1/tickets/tkt_5 \
  -H "x-api-key: YOUR_API_KEY"

Response

json

{
  "success": true,
  "data": {
    "ticket": {
      "id": "tkt_5",
      "number": 1043,
      "subject": "Cannot log in",
      "status": "OPEN",
      "priority": "HIGH",
      "requester": { "id": "vis_1", "name": "Sara", "email": "[email protected]" },
      "assignee": { "id": "usr_agent_1", "name": "Mona" },
      "comments": [ { "id": "cmt_1", "body": "Looking into it", "isInternal": false } ],
      "events": [ { "id": "evt_1", "type": "created" } ]
    },
    "requesterContext": {
      "otherTickets": [ { "id": "tkt_2", "number": 1001, "subject": "Billing" } ],
      "conversations": [ { "id": "cnv_1", "status": "CLOSED" } ]
    }
  }
}

PATCH/tickets/{id}

Update a ticket. Provide at least one field. Setting status to SOLVED triggers a CSAT survey.

Body

Field	Type	Description
`status`	`"NEW" \| "OPEN" \| "PENDING" \| "ON_HOLD" \| "SOLVED" \| "CLOSED"`	New ticket status.
`priority`	`string`	Ticket priority.
`type`	`string`	Ticket type.
`assigneeId`	`string \| null`	Optional agent to assign.
`departmentId`	`string \| null`	Optional department to route to.
`tags`	`string[]`	Up to 50 free-form tags.
`subject`	`string (1–500)`	Ticket subject, 1–500 characters.

Request

bash

curl -X PATCH https://awn.care/api/v1/tickets/tkt_5 \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "status": "SOLVED", "assigneeId": "usr_agent_1" }'

POST/tickets/{id}/comments

Add a comment. Public replies email the other party; internal notes stay private.

Body

Field	Type	Description
`body`Required	`string`	The comment text.
`isInternal`	`boolean`	When true, the comment is an internal note (default false).

Request

bash

curl -X POST https://awn.care/api/v1/tickets/tkt_5/comments \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "body": "We deployed a fix — please try again.", "isInternal": false }'

Response

json

{
  "success": true,
  "data": {
    "comment": { "id": "cmt_2", "body": "We deployed a fix — please try again.", "isInternal": false },
    "statusChanged": "PENDING"
  }
}

Articles

Manage knowledge base articles (bilingual title and content).

GET/articles

List articles, newest first. Paginated.

Query parameters

Field	Type	Description
`status`	`string`	Filter by status (e.g. DRAFT, PUBLISHED).
`category_id`	`string`	Filter by category.
`search`	`string`	Match Arabic/English title or content.
`page`	`number`	Page number (default 1).
`per_page`	`number`	Items per page (default 25, max 100).

Request

bash

curl "https://awn.care/api/v1/articles?status=PUBLISHED&search=refund" \
  -H "x-api-key: YOUR_API_KEY"

POST/articles

Create an article. Slugs are generated automatically from the titles.

Body

Field	Type	Description
`titleAr`Required	`string`	Arabic title.
`titleEn`Required	`string`	English title.
`contentAr`	`string`	Arabic body.
`contentEn`	`string`	English body.
`categoryId`	`string`	Category to file the article under.
`status`	`"DRAFT" \| "PUBLISHED"`	Publication status (default DRAFT).
`keywords`	`string[]`	Search keywords.

Request

bash

curl -X POST https://awn.care/api/v1/articles \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "titleAr": "سياسة الاسترداد",
    "titleEn": "Refund policy",
    "contentAr": "…",
    "contentEn": "…",
    "categoryId": "cat_1",
    "status": "PUBLISHED",
    "keywords": ["refund", "returns"]
  }'

Response

json

{
  "success": true,
  "data": {
    "id": "art_7",
    "titleAr": "سياسة الاسترداد",
    "titleEn": "Refund policy",
    "slugEn": "refund-policy",
    "status": "PUBLISHED",
    "category": { "id": "cat_1", "nameEn": "Billing" }
  }
}

PATCH/articles/{id}

Update an article. Content changes snapshot a prior version.

Request

bash

curl -X PATCH https://awn.care/api/v1/articles/art_7 \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "status": "PUBLISHED" }'

DELETE/articles/{id}

Delete an article permanently.

Request

bash

curl -X DELETE https://awn.care/api/v1/articles/art_7 \
  -H "x-api-key: YOUR_API_KEY"

FAQs

Manage bilingual frequently asked questions. The list endpoint returns a plain array (no pagination).

GET/faqs

List FAQs, ordered by sort order.

Query parameters

Field	Type	Description
`categoryId`	`string`	Filter by (or file under) a category.
`q`	`string`	Match the question or answer text.

Request

bash

curl "https://awn.care/api/v1/faqs?categoryId=cat_1" \
  -H "x-api-key: YOUR_API_KEY"

Response

json

{
  "success": true,
  "data": [
    {
      "id": "faq_3",
      "questionEn": "How do I request a refund?",
      "answerEn": "…",
      "published": true,
      "sortOrder": 0,
      "category": { "id": "cat_1", "nameAr": "الفوترة", "nameEn": "Billing" }
    }
  ]
}

POST/faqs

Create an FAQ. All four bilingual fields are required.

Body

Field	Type	Description
`questionAr`Required	`string`	Arabic question.
`questionEn`Required	`string`	English question.
`answerAr`Required	`string`	Arabic answer.
`answerEn`Required	`string`	English answer.
`categoryId`	`string`	Filter by (or file under) a category.
`published`	`boolean`	Whether the FAQ is visible (default true).
`sortOrder`	`number`	Ordering weight (default 0).

Request

bash

curl -X POST https://awn.care/api/v1/faqs \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "questionAr": "كيف أطلب استردادًا؟",
    "questionEn": "How do I request a refund?",
    "answerAr": "…",
    "answerEn": "…",
    "categoryId": "cat_1",
    "published": true,
    "sortOrder": 0
  }'

PATCH/faqs/{id}

Update an FAQ.

Request

bash

curl -X PATCH https://awn.care/api/v1/faqs/faq_3 \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "published": false }'

DELETE/faqs/{id}

Delete an FAQ.

Request

bash

curl -X DELETE https://awn.care/api/v1/faqs/faq_3 \
  -H "x-api-key: YOUR_API_KEY"

Departments

Manage routing departments. The list endpoint returns a plain array.

GET/departments

List all departments, oldest first.

Request

bash

curl https://awn.care/api/v1/departments \
  -H "x-api-key: YOUR_API_KEY"

Response

json

{
  "success": true,
  "data": [
    {
      "id": "dep_2",
      "nameAr": "المبيعات",
      "nameEn": "Sales",
      "isDefault": false,
      "isOnline": true,
      "priority": 0,
      "skills": []
    }
  ]
}

POST/departments

Create a department.

Body

Field	Type	Description
`nameAr`Required	`string`	Arabic name.
`nameEn`Required	`string`	English name.
`description`	`string`	Optional description.
`isDefault`	`boolean`	Make this the default department (un-defaults the others).
`isOnline`	`boolean`	Whether the department accepts chats (default true).
`priority`	`number`	Routing priority weight (default 0).
`skills`	`string[]`	Skill tags used by skills-based routing.

Request

bash

curl -X POST https://awn.care/api/v1/departments \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "nameAr": "المبيعات",
    "nameEn": "Sales",
    "isOnline": true,
    "priority": 0
  }'

PATCH/departments/{id}

Update a department.

Request

bash

curl -X PATCH https://awn.care/api/v1/departments/dep_2 \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "isOnline": false }'

DELETE/departments/{id}

Delete a department. The default department cannot be deleted.

Request

bash

curl -X DELETE https://awn.care/api/v1/departments/dep_2 \
  -H "x-api-key: YOUR_API_KEY"

Saved replies

Manage canned responses (macros) keyed by a shortcut. The list endpoint returns a plain array.

GET/saved-replies

List saved replies, newest first.

Query parameters

Field	Type	Description
`search`	`string`	Match shortcut or title.

Request

bash

curl "https://awn.care/api/v1/saved-replies?search=refund" \
  -H "x-api-key: YOUR_API_KEY"

Response

json

{
  "success": true,
  "data": [
    {
      "id": "sr_4",
      "shortcut": "/refund",
      "titleEn": "Refund approved",
      "contentAr": "تمت الموافقة على الاسترداد.",
      "contentEn": "Your refund has been approved."
    }
  ]
}

POST/saved-replies

Create a saved reply. The shortcut must be unique in the workspace.

Body

Field	Type	Description
`shortcut`Required	`string`	The trigger shortcut, e.g. /refund. Must be unique.
`titleAr`	`string`	Arabic title (defaults to the shortcut).
`titleEn`	`string`	English title (defaults to the shortcut).
`contentAr`Required	`string`	Arabic reply body.
`contentEn`Required	`string`	English reply body.

Request

bash

curl -X POST https://awn.care/api/v1/saved-replies \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "shortcut": "/refund",
    "titleEn": "Refund approved",
    "contentAr": "تمت الموافقة على الاسترداد.",
    "contentEn": "Your refund has been approved."
  }'

PATCH/saved-replies/{id}

Update a saved reply.

Request

bash

curl -X PATCH https://awn.care/api/v1/saved-replies/sr_4 \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "contentEn": "Your refund is on its way." }'

DELETE/saved-replies/{id}

Delete a saved reply.

Request

bash

curl -X DELETE https://awn.care/api/v1/saved-replies/sr_4 \
  -H "x-api-key: YOUR_API_KEY"

Webhooks management

Programmatically create and manage webhook endpoints. See the Webhooks guide for delivery, signing, and retries.

For the event catalog, envelope shape, and signature verification, see the Webhooks guide.

GET/webhooks

List webhook endpoints. Secrets are masked. Paginated.

Request

bash

curl https://awn.care/api/v1/webhooks \
  -H "x-api-key: YOUR_API_KEY"

POST/webhooks

Create an endpoint. The full signing secret is returned exactly once — store it now.

Body

Field	Type	Description
`url`Required	`string (https)`	HTTPS endpoint URL (http allowed only for localhost).
`events`Required	`string[]`	Non-empty array of event names to subscribe to.
`description`	`string`	Optional label for the endpoint.

Request

bash

curl -X POST https://awn.care/api/v1/webhooks \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://example.com/hooks/awncare",
    "events": ["ticket.created", "message.created"],
    "description": "Prod ticket sync"
  }'

Response

json

{
  "success": true,
  "data": {
    "id": "whk_1",
    "url": "https://example.com/hooks/awncare",
    "events": ["ticket.created", "message.created"],
    "description": "Prod ticket sync",
    "active": true,
    "failCount": 0,
    "secret": "whsec_9c1f…full-secret-shown-once…",
    "createdAt": "2026-07-31T09:00:00.000Z"
  }
}

GET/webhooks/{id}

Retrieve an endpoint (secret masked).

Request

bash

curl https://awn.care/api/v1/webhooks/whk_1 \
  -H "x-api-key: YOUR_API_KEY"

PATCH/webhooks/{id}

Update an endpoint's url, events, active flag, or description.

Body

Field	Type	Description
`url`	`string (https)`	HTTPS endpoint URL (http allowed only for localhost).
`events`	`string[]`	Non-empty array of event names to subscribe to.
`active`	`boolean`	Enable or disable the endpoint. Re-enabling resets the failure count.
`description`	`string \| null`	Optional label for the endpoint.

Request

bash

curl -X PATCH https://awn.care/api/v1/webhooks/whk_1 \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "active": false }'

DELETE/webhooks/{id}

Delete an endpoint.

Request

bash

curl -X DELETE https://awn.care/api/v1/webhooks/whk_1 \
  -H "x-api-key: YOUR_API_KEY"

POST/webhooks/{id}/test

Send a live ping to the endpoint. Does not affect its failure count.

Request

bash

curl -X POST https://awn.care/api/v1/webhooks/whk_1/test \
  -H "x-api-key: YOUR_API_KEY"

GET/webhooks/{id}/deliveries

List the latest 50 delivery attempts for an endpoint.

Request

bash

curl https://awn.care/api/v1/webhooks/whk_1/deliveries \
  -H "x-api-key: YOUR_API_KEY"

Response

json

{
  "success": true,
  "data": [
    {
      "id": "dlv_20",
      "event": "ticket.created",
      "status": "success",
      "attempts": 1,
      "responseCode": 200,
      "error": null,
      "nextRetryAt": null,
      "createdAt": "2026-07-31T09:01:00.000Z",
      "deliveredAt": "2026-07-31T09:01:00.420Z"
    }
  ]
}

Reports

A read-only analytics summary for a date range.

GET/reports

Return aggregate metrics — volumes, response and resolution times, breakdowns, top agents, and time series.

Query parameters

Field	Type	Description
`range`	`number (days)`	Number of days back to include (default 7).
`from`	`ISO date`	Start date (ISO). Use with 'to' instead of range.
`to`	`ISO date`	End date (ISO), inclusive of the whole day.

Request

bash

curl "https://awn.care/api/v1/reports?range=7" \
  -H "x-api-key: YOUR_API_KEY"

Response

json

{
  "success": true,
  "data": {
    "totalConversations": 1280,
    "conversationsInRange": 214,
    "messagesInRange": 3120,
    "avgFirstResponseMs": 48000,
    "avgResolutionMs": 5400000,
    "resolutionRate": 0.86,
    "statusBreakdown": { "OPEN": 42, "CLOSED": 172 },
    "channelBreakdown": [ { "channel": "CHAT", "count": 180 } ],
    "topAgents": [ { "id": "usr_agent_1", "name": "Mona", "conversations": 64 } ],
    "conversationsByDay": [ { "date": "2026-07-25", "count": 31 } ]
  }
}

Visitors

Read and update visitor (contact) profiles.

There is no list or create endpoint for visitors, and no delete — only get and update by id.

GET/visitors/{id}

Retrieve a visitor profile with tags and conversation/message counts.

Request

bash

curl https://awn.care/api/v1/visitors/vis_1 \
  -H "x-api-key: YOUR_API_KEY"

Response

json

{
  "success": true,
  "data": {
    "id": "vis_1",
    "name": "Sara Al-Otaibi",
    "email": "[email protected]",
    "role": "LEAD",
    "online": false,
    "metadata": { "company": "Acme", "visitCount": 4 }
  }
}

PATCH/visitors/{id}

Update a visitor. Role changes are promotion-only (VISITOR → LEAD → USER). Contact fields are merged into metadata.

Body

Field	Type	Description
`name`	`string \| null`	Display name, or null to clear.
`email`	`string \| null`	Email address, or null to clear.
`phone`	`string`	Phone number (stored in metadata).
`company`	`string`	Company name (stored in metadata).
`role`	`"LEAD" \| "USER"`	Promote the contact (VISITOR → LEAD → USER).
`score`	`number`	Lead score (integer).

Request

bash

curl -X PATCH https://awn.care/api/v1/visitors/vis_1 \
  -H "x-api-key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "name": "Sara Al-Otaibi", "company": "Acme", "score": 80 }'

REST API

Conventions

Base URL

Authentication

Response envelope

Conversations

Tickets

Articles

FAQs

Categories

Departments

Saved replies

Webhooks management

Reports

Visitors