Pause invitations
Pauses invitations that are in progress, keeping them and their place in the queue.
POST https://cotlet.dev/api/v1/reviews-io/invitations/pause
write
Pauses up to 100 invitations per call, the same as the dashboard. Only in_progress invitations can be paused. A paused invitation is not deleted and is undone with resume_invitations, so this tool does not ask for your OK. Customers get nothing while it is paused.
Parameters
| Name | Type | Description |
|---|---|---|
| invitation_ids array required | array | Invitation IDs from list_invitations, up to 100. |
Request
curl -X POST https://cotlet.dev/api/v1/reviews-io/invitations/pause \
-H "Authorization: Bearer $COTLET_API_KEY" \
-H "Content-Type: application/json" \
-d '{"invitation_ids":["9120456","9120457","9120460"]}'result = client.call("reviews-io", "pause_invitations", {"invitation_ids":["9120456","9120457","9120460"]})const result = await cotlet.call('reviews-io', 'pause_invitations', {"invitation_ids":["9120456","9120457","9120460"]});cotlet call reviews-io pause_invitations --data '{"invitation_ids":["9120456","9120457","9120460"]}'Example response
{
"paused": 3,
"invitations": [
{
"invitation_id": "9120456",
"status": "paused"
},
{
"invitation_id": "9120457",
"status": "paused"
},
{
"invitation_id": "9120460",
"status": "paused"
}
],
"skipped": []
}