---
title: "Create a new outplan."
method: POST
path: "/outplans"
tags: ["Outplan"]
---

# Create a new outplan.

`POST /outplans`

Creates a new outplan with the provided details and returns the created outplan.

## Request body

- object
  - `name` string, required — The name of the outplan.
  - `detail` string, required — Additional details about the outplan.
  - `source` CommonAddress, required — Contains source or destination detail info.
    - `type` '' | 'agent' | 'conference' | 'email' | 'extension' | 'line' | 'sip' | 'tel' | 'web_session' — Type of address.
    - `target` string — The address endpoint. Format depends on type: phone number for tel (e.g. +14155551234), UUID for agent/conference/extension, email for email, SIP URI for sip.
    - `target_name` string — Address's name.
    - `name` string — Optional label for this address.
    - `detail` string — Additional notes about this address.
  - `dial_timeout` integer, required — The dial timeout in seconds.
  - `try_interval` integer, required — The interval between retry attempts.
  - `max_try_count_0` integer, required — Maximum retry count for destination 0.
  - `max_try_count_1` integer, required — Maximum retry count for destination 1.
  - `max_try_count_2` integer, required — Maximum retry count for destination 2.
  - `max_try_count_3` integer, required — Maximum retry count for destination 3.
  - `max_try_count_4` integer, required — Maximum retry count for destination 4.

## Response `200`

The created outplan details.

- CampaignManagerOutplan
  - `id` string, uuid — The unique identifier of the outplan.
  - `customer_id` string, uuid — The unique identifier of the customer. Returned from the `GET /customers` response.
  - `name` string — Name of the outplan.
  - `detail` string — Detailed information about the outplan.
  - `source` CommonAddress — Contains source or destination detail info.
    - `type` '' | 'agent' | 'conference' | 'email' | 'extension' | 'line' | 'sip' | 'tel' | 'web_session' — Type of address.
    - `target` string — The address endpoint. Format depends on type: phone number for tel (e.g. +14155551234), UUID for agent/conference/extension, email for email, SIP URI for sip.
    - `target_name` string — Address's name.
    - `name` string — Optional label for this address.
    - `detail` string — Additional notes about this address.
  - `dial_timeout` integer — Dial timeout in milliseconds.
  - `try_interval` integer — Interval between dialing attempts in milliseconds.
  - `max_try_count_0` integer — Maximum number of tries for level 0.
  - `max_try_count_1` integer — Maximum number of tries for level 1.
  - `max_try_count_2` integer — Maximum number of tries for level 2.
  - `max_try_count_3` integer — Maximum number of tries for level 3.
  - `max_try_count_4` integer — Maximum number of tries for level 4.
  - `tm_create` string, date-time — Timestamp when the outplan was created.
  - `tm_update` string, date-time — Timestamp when the outplan was last updated.
  - `tm_delete` string, date-time — Timestamp when the outplan was deleted.

## Other responses

- `400` — Invalid request (INVALID_ARGUMENT).
- `401` — Authentication required (UNAUTHENTICATED).
- `500` — Internal error (INTERNAL).

---

[API](https://skmtc.net/voipbin/apis/voipbin-api.md) · [All operations](https://skmtc.net/voipbin/apis/voipbin-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/voipbin/voipbin-api/versions/79e779080bcc/schema)