Create a phone-system outcome

const url = 'https://api.sailorhq.io/phone-system/outcomes';
const options = {
  method: 'POST',
  headers: {
    'Idempotency-Key': 'Idempotency-Key',
    Authorization: 'Bearer <token>',
    'Content-Type': 'application/json'
  },
  body: '{"outcome_name":"Add to VIP List","outcome_type":"action","order":10,"destination_type":"smart_list"}'
};
try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

{
  "ok": true,
  "outcome": {
    "outcome_id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "outcome_name": "Add to VIP List",
    "outcome_type": "action",
    "order": 10,
    "destination_type": "smart_list",
    "destination": {
      "destination_type": "smart_list",
      "destination_id": "1c9d4f2e-8b3a-4f7a-9d2e-3f4a5b6c7d8e",
      "destination_name": "VIP Customers"
    },
    "webhook_url": "https://webhooks.example.com/customer-updates",
    "created_at": "2024-06-10T12:00:00Z",
    "updated_at": "2024-06-10T12:00:00Z"
  },
  "disposition_popup_enabled": false
}

Creates an outcome that can optionally call a customer webhook, add the contacted person to a smart list, or remove them from selected smart lists.

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.

outcome_namestringRequired1-120 characters

outcome_typeenumRequired

Allowed values:

orderintegerRequired-2147483648-2147483647Defaults to 0

destination_typeenumRequiredDefaults to none

Allowed values:

destination_idstringOptionalformat: "uuid"

remove_from_smart_listsobjectOptional

webhook_urlstring or nullOptionalformat: "uri"<=2048 characters

Response

Outcome created.

oktrue

outcomeobject

disposition_popup_enabledboolean

Authentication

Headers

Request

Response