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":"Interested","outcome_type":"disposition","order":10,"destination_type":"none"}'
};
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": "00000000-0000-4000-8000-000000000001",
    "outcome_name": "Interested",
    "outcome_type": "disposition",
    "order": 10,
    "destination_type": "none",
    "destination": null,
    "webhook_url": null,
    "created_at": "2026-08-07T00:00:00.000Z",
    "updated_at": "2026-08-07T00:00:00.000Z"
  },
  "disposition_popup_enabled": true
}

Creates an outcome in the credential's workspace. A later call event may invoke a configured webhook.

Authentication

AuthorizationBearer

Workspace API key created in Sailor Settings > Integrations > API access.

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 headers

X-Request-IdstringOptional

Stable request identifier for support and observability.

RateLimit-PolicystringOptional

Versioned structured quota policy. The syntax follows IETF RateLimit draft 11 and may evolve before standardization.

RateLimitstringOptional

Current structured quota state for the authenticated credential.

Idempotent-ReplayedstringOptional

True when this exact response was replayed from a completed idempotency record.

Response

Outcome created.

oktrue

outcomeobject

disposition_popup_enabledboolean

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error

404

Not Found Error

409

Conflict Error

413

Content Too Large Error

415

Unsupported Media Type Error

422

Unprocessable Entity Error

429

Too Many Requests Error

503

Service Unavailable Error

Authentication

Headers

Request

Response headers

Response

Errors