Skip to main content

Overview

PingBack provides three status-transition endpoints for conversations:
  • Resolve — marks a conversation as resolved and records the resolved_at timestamp.
  • Close — marks a conversation as closed and records the closed_at timestamp.
  • Assign — reassigns a conversation to a different agent.
These are separate PUT operations so you can model your support workflow precisely.

Resolve a conversation

Sets the conversation’s status to "resolved" and records resolved_at. Method: PUT URL: /api/v1/conversations/{conversation_id}/resolve

Headers

HeaderValue
AuthorizationBearer

Path parameters

conversation_id
string (UUID)
required
The UUID of the conversation to resolve.
No request body is required.

Response

resolved_at
string (ISO 8601)
Timestamp when the conversation was resolved.
If the conversation is already resolved, the endpoint returns {"detail": "Already resolved"} with a 200 status.

Example

curl -X PUT https://api.pingback.live/api/v1/conversations/c3d4e5f6-a7b8-9012-cdef-123456789012/resolve \
  -H "Authorization: Bearer YOUR_TOKEN"

Response example

{
  "resolved_at": "2024-03-01T10:30:00Z"
}

Close a conversation

Sets the conversation’s status to "closed" and records closed_at. Method: PUT URL: /api/v1/conversations/{conversation_id}/close

Headers

HeaderValue
AuthorizationBearer

Path parameters

conversation_id
string (UUID)
required
The UUID of the conversation to close.
No request body is required.

Response

closed_at
string (ISO 8601)
Timestamp when the conversation was closed.
If the conversation is already closed, the endpoint returns {"detail": "Already closed"} with a 200 status.

Example

curl -X PUT https://api.pingback.live/api/v1/conversations/c3d4e5f6-a7b8-9012-cdef-123456789012/close \
  -H "Authorization: Bearer YOUR_TOKEN"

Response example

{
  "closed_at": "2024-03-01T11:00:00Z"
}

Assign a conversation

Reassigns a conversation to a different agent. Method: PUT URL: /api/v1/conversations/{conversation_id}/assign/{agent_id}

Headers

HeaderValue
AuthorizationBearer

Path parameters

conversation_id
string (UUID)
required
The UUID of the conversation to reassign.
agent_id
integer
required
The ID of the agent to assign the conversation to.
No request body is required.

Response

assignee_id
integer
The ID of the newly assigned agent.

Example

curl -X PUT https://api.pingback.live/api/v1/conversations/c3d4e5f6-a7b8-9012-cdef-123456789012/assign/5 \
  -H "Authorization: Bearer YOUR_TOKEN"

Response example

{
  "assignee_id": 5
}

Errors

StatusMeaning
401Unauthorized — missing or invalid Bearer token
404Conversation not found