Conversations

getConversationActionStatus - Get action status

<div class="extension-title">Description</div>

Use this API to check the status of your asynchronous conversation action.

get/conversations/actions/{actionId}

Request

Base URL
https://miraklconnect.com/api
Auth
HTTP bearer
TypeScript
https://skmtc.dev/mirakl/apis/mirakl-connect-apis/docs/conversations/actions/:actionId/get.ts
A function with typed inputs. Its response is checked against the schema.

actionIdstring required

Unique identifier of the action

Action status retrieved successfully

conversation_idstring

Identifier of the related conversation.

created_atstring date-time required

Date and time when the action was created

idstring required

Unique identifier of the action

status'PENDING' | 'SUCCESS' | 'ERROR' required

Status of an asynchronous conversation action

updated_atstring date-time required

Date and time when the action was last updated

{
  "errors": [
    {
      "code": "DATA_NOT_FOUND",
      "message": "Conversation not found for the given ID."
    }
  ],
  "id": "abcd"
}