End a care chat

curl --request DELETE \
  --url https://api.lightspark.com/grid/2025-10-13/care/chats/{chatId} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'DELETE', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.lightspark.com/grid/2025-10-13/care/chats/{chatId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.lightspark.com/grid/2025-10-13/care/chats/{chatId}")
  .delete(null)
  .addHeader("Authorization", "Basic <encoded-value>")
  .build()

val response = client.newCall(request).execute()

{
  "code": "CARE_SESSION_EXPIRED",
  "reason": "The care session token is not valid."
}

{
  "code": "CARE_SESSION_EXPIRED",
  "reason": "The care session token is not valid."
}

{
  "code": "CARE_SESSION_EXPIRED",
  "reason": "The care session token is not valid."
}

{
  "code": "CARE_SESSION_EXPIRED",
  "reason": "The care session token is not valid."
}

{
  "code": "CARE_SESSION_EXPIRED",
  "reason": "The care session token is not valid."
}

{
  "code": "CARE_SESSION_EXPIRED",
  "reason": "The care session token is not valid."
}

Embedded Care

End a care chat

Close a chat the cardholder has finished with or navigated away from. The conversation stops accepting messages; sending one afterwards is refused with CARE_CHAT_ENDED, and the cardholder starts a new chat by sending another message.

No session token is required, even on a verified chat. Ending a chat touches no account data, and requiring a live session would mean a partner whose cardholder walked away could not close the chat without texting them another code first. The chat only has to belong to the calling platform.

Closing a chat that is already closed is not an error: that is the state the caller asked for.

Requires a token with the VIEW permission.

DELETE

care

chats

{chatId}

End a care chat

curl --request DELETE \
  --url https://api.lightspark.com/grid/2025-10-13/care/chats/{chatId} \
  --header 'Authorization: Basic <encoded-value>'

const options = {method: 'DELETE', headers: {Authorization: 'Basic <encoded-value>'}};

fetch('https://api.lightspark.com/grid/2025-10-13/care/chats/{chatId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://api.lightspark.com/grid/2025-10-13/care/chats/{chatId}")
  .delete(null)
  .addHeader("Authorization", "Basic <encoded-value>")
  .build()

val response = client.newCall(request).execute()

{
  "code": "CARE_SESSION_EXPIRED",
  "reason": "The care session token is not valid."
}

{
  "code": "CARE_SESSION_EXPIRED",
  "reason": "The care session token is not valid."
}

{
  "code": "CARE_SESSION_EXPIRED",
  "reason": "The care session token is not valid."
}

{
  "code": "CARE_SESSION_EXPIRED",
  "reason": "The care session token is not valid."
}

{
  "code": "CARE_SESSION_EXPIRED",
  "reason": "The care session token is not valid."
}

{
  "code": "CARE_SESSION_EXPIRED",
  "reason": "The care session token is not valid."
}

Authorizations

Authorization

string

header

required

API token authentication using format <api token id>:<api client secret>

Path Parameters

chatId

string

required

The chat to close, as returned in chatId by POST /care/chats/{chatId}/messages.

Response

The chat is closed. No content.

Using the API

API documentation

End a care chat

Authorizations

Path Parameters

Response