Activities
Set a call's outcome
Sets or corrects how a call ended, using one of the workspace's call outcome values. The change is written on the ticket's timeline, and undo reverts a previous change.
Requires: desk.write scope, Converse licence.
Authorization
bearerAuth AuthorizationBearer <token>
A SautiDesk API key. An owner or admin makes it under Settings in SautiDesk for a named person and picks the scopes. The key is shown once. Send it as Authorization: Bearer <key>. It acts as that person and as nobody else.
In: header
Path Parameters
id*string
The activity's id (a UUID).
Request Body
application/json
Response
OK
Example
{ "activity_id": "0d6c4f09-7095-4291-9bdb-50991c39602c", "outcome": "billing", "changed": false, "ticket": { "source": "example", "campaign_id": "f19d5173-dd17-4475-9e73-13d22446ed31", "campaign_name": "example", "id": "3f2b8c1e-5a4d-4e7b-9c10-2d6a8e4f1b37", "ref": "TCK-4471", "subject": "Order 1182 has not arrived", "channel": "sms", "category": "billing", "status": "open", "owner": "Wanjiku Mwangi", "owner_id": "1dc86aaf-2f65-4b1b-9ef7-7dabe869da64", "follows_id": "1fc0434e-757b-40d3-9fec-400c7ee95e3f", "participating": false, "queue_id": "c70c2d37-4d65-4ba4-9843-5e8aaf2dae40", "queue_name": "Support", "contact_id": "e370603e-5791-443e-9fb1-26dedb014cd9", "contact_name": "Amina Wanjiru", "contact_number": "+254712345678", "contact_email": "amina@example.com", "opened_at": "2026-10-14T08:30:00Z", "updated_at": "2026-10-14T08:30:00Z", "closed_at": "2026-10-14T08:30:00Z", "widget_seen_at": "2026-10-14T08:30:00Z", "last_customer_at": "2026-10-14T08:30:00Z", "last_outcome": "Resolved", "last_outcome_activity_id": "bae3f648-c3f5-4e80-91d8-4a9b8be23ba2", "ticket_outcome": "Resolved", "last_call_leg_id": "a54c310b-3cde-4687-9f40-f61a908d7e93" }}FieldTypeDescription
activity_idrequiredstring (uuid)The id of the message on the ticket to forward.outcomerequiredstringHow it ended: the name or id of one of your outcomes.changedrequiredbooleanticketrequiredobjectThe ticket the call belongs to, by id or reference such as TCK-4471.sourcestringcampaign_idstringcampaign_namestringidrequiredstring (uuid)refrequiredstringsubjectrequiredstringThe subject line.channelrequiredstringThe channel to use: sms, whatsapp or email.categorystringThe name of the category.statusrequiredstringThe status to set.ownerstring | nullowner_idstring | nullfollows_idstring | nullparticipatingrequiredbooleanqueue_idrequiredstringThe id of the queue that receives what arrives here.queue_namerequiredstringcontact_idrequiredstring (uuid)The id of the contact the task is about.contact_namerequiredstringcontact_numberrequiredstringcontact_emailrequiredstringopened_atrequiredstring (date-time)updated_atrequiredstring (date-time)closed_atstring (date-time) | nullwidget_seen_atstring (date-time) | nulllast_customer_atstring (date-time) | nulllast_outcomerequiredstring | nulllast_outcome_activity_idrequiredstring (uuid) | nullticket_outcomerequiredstringlast_call_leg_idrequiredstring (uuid) | nullcurl -X PATCH "https://api.sautidesk.com/v1/desk/activities/string/outcome" \ -H "Content-Type: application/json" \ -d '{ "outcome": "billing", "undo": false }'