Archives one conversation by setting its `archivedAt` timestamp. Archive is orthogonal to status — an archived conversation keeps its open/closed identity.…
bearerAuth In: header
application/json
TypeScript Definitions
Use the request body type in TypeScript.
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
application/json
curl -X POST "https://example.com/api/conversations/497f6eca-6276-4993-bfeb-53cbbbba6f08/archive" \ -H "Content-Type: application/json" \ -d '{ "reason": "Resolved — yearly recurring question" }'{
"id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
"orgId": "25b2c2d5-a7fc-47d0-89e4-8709a1560bfa",
"visitorId": "e45934e1-5fd4-4651-b7bc-50c977a3b8c5",
"assignedOperatorId": "50ea37db-eb78-4097-9145-d999eb03fc48",
"status": "string",
"priority": "string",
"resolvedBy": "string",
"channel": "string",
"aiActive": true,
"snoozedUntil": "2019-08-24T14:15:22Z",
"lastMessageAt": "2019-08-24T14:15:22Z",
"metadata": {},
"createdAt": "2019-08-24T14:15:22Z",
"updatedAt": "2019-08-24T14:15:22Z",
"searchVector": "string"
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}{
"error": {
"code": "string",
"message": "string",
"fields": {
"property1": "string",
"property2": "string"
},
"details": {},
"correlationId": "string"
}
}Try it
Your API key is sent directly to the Convor API from your browser and is never stored on this site.
Was this page helpful?