Archive or label many conversations
The same change as updating one conversation, for up to 100 at once. The answer lists each conversation: a conversation that is not yours, or is not in the status you expected, is reported as not changed and the others still apply.
Requires an API key with the conversations:manage scope.
apiKeyAuthorizationBearer <token>A secret API key from the dashboard (Developers → API keys): vl_live_…, or vl_test_… for test mode. Each operation says which scope the key needs.
idempotency-key?stringA unique value (a UUID works) that makes a retry safe: sending the same key again returns the first result instead of acting twice. 1–255 printable characters.
1 <= length <= 255application/json- body
status?stringarchived puts them away; open brings them back to the inbox.
"open""archived""deleted"handled?booleantrue marks them as dealt with; false puts them back to needing attention.
read?booleantrue marks them read for you, false unread. Only you are affected.
addLabels?array<>Labels to put on each.
items <= 20removeLabels?array<>Labels to take off each.
items <= 20expectedStatus?stringChange each only if it is still in this status.
"open""closed""archived""deleted"conversationIds*array<>The conversations to change, 1 to 100.
1 <= items <= 100One result per conversation, in the order asked, and a one-sentence summary
application/json- response
results*array<>summary*stringcurl -X POST https://api.vlayers.ai/v1/conversations/state \ -H "Authorization: Bearer $VOICELAYER_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "conversationIds": [ "0192f5b0-7c3e-7a51-9b2d-4e8f1a6c3d21" ], "status": "archived" }'{ "results": [ { "id": "0192f5b0-7c3e-7a51-9b2d-4e8f1a6c3d21", "ok": true, "changed": true } ], "summary": "Archived 1 conversation."}