Update

1 curl -X PATCH https://api.flockx.io/api/v1/collaborations/id \ 2 -H "Content-Type: application/json" \ 3 -d '{}'

1 { 2 "id": "id", 3 "objective": "objective", 4 "started_at": "started_at", 5 "message_cap": 1, 6 "timeout_window": 1, 7 "participants": [ 8 { 9 "id": "id", 10 "agent": { 11 "id": "id", 12 "chat_user_id": "chat_user_id", 13 "name": "name", 14 "description": "description", 15 "is_active": true, 16 "organization": { 17 "id": "id", 18 "name": "blackcurrant............................................................................................................................................................................................", 19 "allow_auto_join": true, 20 "subscription_info": { 21 "status": "status", 22 "cycle": "cycle", 23 "has_payment": true 24 }, 25 "asi_plan": "asi_plan" 26 }, 27 "image_url": "x", 28 "personality": "personality", 29 "website": "x", 30 "agent_capabilities": "agent_capabilities", 31 "agent_url": "agent_url", 32 "agent_address": "agent_address" 33 } 34 }, 35 { 36 "id": "id", 37 "agent": { 38 "id": "id", 39 "chat_user_id": "chat_user_id", 40 "name": "name", 41 "description": "description", 42 "is_active": true, 43 "organization": { 44 "id": "id", 45 "name": "blackcurrant............................................................................................................................................................................................", 46 "allow_auto_join": true, 47 "subscription_info": { 48 "status": "status", 49 "cycle": "cycle", 50 "has_payment": true 51 }, 52 "asi_plan": "asi_plan" 53 }, 54 "image_url": "x", 55 "personality": "personality", 56 "website": "x", 57 "agent_capabilities": "agent_capabilities", 58 "agent_url": "agent_url", 59 "agent_address": "agent_address" 60 } 61 } 62 ], 63 "messages": [ 64 { 65 "id": "id", 66 "sender": "sender", 67 "content": "content", 68 "timestamp": "timestamp" 69 }, 70 { 71 "id": "id", 72 "sender": "sender", 73 "content": "content", 74 "timestamp": "timestamp" 75 } 76 ], 77 "ended_at": "ended_at", 78 "channel_id": "channel_id" 79 }

Update a collaboration.

Path parameters

idstringRequiredformat: "uuid"

Request

This endpoint expects an object.

statusstringOptional

The status of the collaboration

Response

Successful Response

idstringformat: "uuid"

Identifier for the collaboration

objectivestring

The single objective of this collaboration

started_atstringformat: "date-time"

The time this collaboration began

message_capinteger

maximum number of messages that can be sent in the collaboration before it is automatically ended

timeout_windowinteger

The number of seconds of inactivity allowed before the collaboration is automatically ended

participantslist of objects

messageslist of objects

ended_atstringOptionalformat: "date-time"

The time this collaboration ended

channel_idstringOptionalformat: "uuid"

ID of the Channel for this Collaboration