> ## Documentation Index > Fetch the complete documentation index at: https://docs.incident.io/llms.txt > Use this file to discover all available pages before exploring further. # Create > Add an option to a call route's phone-tree menu. Callers hear the menu instead of being routed down the route's own path, so adding the first option clears that path. Every plan allows a single option. A menu of two or more options is not on every plan, so get in touch if you need one enabled. 🔑 Requires the `call_routes.update` scope. ## OpenAPI ````yaml /openapi/tags/call-route-options-v2.json post /v2/call_routes/{call_route_id}/options openapi: 3.0.3 info: description: "This is the API reference for incident.io.\n\nIt documents available API endpoints, provides examples of how to use it, and\ninstructions around things like authentication and error handling.\n\nThe API is hosted at:\n\n- https://api.incident.io/\n\nAnd you will need to create an API key via your [incident.io\ndashboard](https://app.incident.io/settings/api-keys) to make requests.\n\n# Making requests\n\nHere are the key concepts required to make requests to the incident.io API.\n\n## Authentication\n\nFor all requests made to the incident.io API, you'll need an API key.\n\nTo create an API key, head to the incident dashboard and visit [API\nkeys](https://app.incident.io/settings/api-keys). When you create the key, you'll be able to choose what actions it\ncan take for your account: choose carefully, as those roles can only be set\nwhen you first create the key. We'll only show you the token once, so make sure\nyou store it somewhere safe.\n\nAPI keys are global to your incident.io account, and can be managed by anyone\nwho has the right permissions. We display the user that created the API key,\nand the API key will remain valid if that user becomes deactivated.\n\nOnce you have the key, you should make requests to the API that set the\n`Authorization` request header using a \"Bearer\" authentication scheme:\n\n```\nAuthorization: Bearer \n```\n\n## Rate Limits\n\nThe incident.io API enforces rate limits to ensure consistent performance for all users.\n\nThe default rate limit is 1200 requests/minute per API key. This limit applies to most endpoints across the API.\n\nLimits are token buckets that refill continuously rather than resetting on a fixed window boundary. The default\nbucket holds 1200 requests and refills at 20 per second, so you can burst up to the full bucket and then sustain\n20 requests/second indefinitely. There is no boundary at which your quota resets to full in one step.\n\nSome endpoints have lower rate limits, particularly those that interact with external third-party systems that impose\ntheir own limitations. These specific limits vary by endpoint.\n\n### Rate limit headers\n\nResponses to requests authenticated with an API key carry your current allowance, so you can pace yourself rather\nthan waiting to be throttled:\n\n```\nX-RateLimit-Limit: 60, 1200;window=60, 60;window=60\nX-RateLimit-Remaining: 59\nX-RateLimit-Used: 1\nX-RateLimit-Reset: 1785173199\n```\n\n| Header | Meaning |\n| --- | --- |\n| `X-RateLimit-Limit` | The quota that binds this request, followed by every limit that applied and the window it applies over |\n| `X-RateLimit-Remaining` | Requests you can make right now against the binding limit |\n| `X-RateLimit-Used` | Requests you have spent against it |\n| `X-RateLimit-Reset` | Unix timestamp (seconds) at which that limit will be back to full |\n\nMore than one limit can apply to a request: your API key's overall limit, and for some endpoints a lower limit of\ntheir own. `X-RateLimit-Limit` lists all of them, each with its window, so `1200;window=60` means 1200 requests per\nminute. Because our limits refill continuously rather than resetting on a boundary, that window is what tells you\nthe rate you can sustain: 1200 per 60 seconds is 20 requests/second indefinitely.\n\n`Remaining`, `Used` and `Reset` describe whichever limit has the least allowance left, since that is the one you\nwill hit first.\n\n`X-RateLimit-Remaining` may lag by a small number of requests under high concurrency, and can move by more than the\nrequests you made, because limits scoped to your whole organisation are shared with your other API keys.\n\nHeaders are omitted rather than guessed if we cannot determine your allowance for a request.\n\n### Exceeding a rate limit\n\nWhen you exceed a rate limit the API responds with `429 Too Many Requests` and a `Retry-After` header giving the\nnumber of seconds to wait:\n\n```\nX-RateLimit-Limit: 1200, 1200;window=60\nX-RateLimit-Remaining: 0\nX-RateLimit-Used: 1200\nX-RateLimit-Reset: 1785173199\nRetry-After: 1\n```\n\nPrefer `Retry-After` over `X-RateLimit-Reset` when deciding how long to back off. `Retry-After` is when a single\nrequest will succeed; `X-RateLimit-Reset` is the later point at which your whole allowance has returned. It is a\nduration rather than a timestamp, so it does not depend on your clock agreeing with ours.\n\nThe 429 also carries a JSON body with the same information:\n\n```json\n{\n \"type\": \"too_many_requests\",\n \"status\": 429,\n \"request_id\": \"b839a403-7704-41c1-bf6a-39a2d68caefa\",\n \"rate_limit\": {\n \"name\": \"api_key_name\",\n \"limit\": 1200,\n \"remaining\": 0,\n \"retry_after\": \"2025-04-17T11:17:18Z\"\n },\n \"errors\": [\n {\n \"code\": \"too_many_requests\",\n \"message\": \"Too many requests hit the API too quickly. We recommend an exponential backoff of your requests.\"\n }\n ]\n}\n```\n\nThe response includes:\n* The name of the API key (`name`)\n* The bucket limit (`limit`)\n* The number of requests remaining (`remaining`)\n* When you can retry requests (`retry_after`), as an RFC3339 timestamp\n\n## Errors\n\nWe use standard HTTP response codes to indicate the status or failure of API\nrequests.\n\nThe API response body will be JSON, and contain more detailed information on the\nnature of the error.\n\nAn example error when a request is made without an API key:\n\n```json\n{\n \"type\": \"authentication_error\",\n \"status\": 401,\n \"request_id\": \"8e3cc412-b49d-4957-9073-2c19d2c61804\",\n \"errors\": [\n {\n \"code\": \"missing_authorization_material\",\n \"message\": \"No authorization material provided in request\"\n }\n ]\n}\n```\n\nNote that the error:\n\n- Contains the HTTP status (`401`)\n- References the type of error (`authentication_error`)\n- Includes a `request_id` that can be provided to incident.io support to help\n\tdebug questions with your API request\n- Provides a list of individual errors, which go into detail about why the error\n\toccurred\n\nThe most common error will be a 422 Validation Error, which is returned when the\nrequest was rejected due to failing validations.\n\nThese errors look like this:\n\n```json\n{\n \"type\": \"validation_error\",\n \"status\": 422,\n \"request_id\": \"631766c4-4afd-4803-997c-cd700928fa4b\",\n \"errors\": [\n {\n \"code\": \"is_required\",\n \"message\": \"A severity is required to open an incident\",\n \"source\": {\n \"field\": \"severity_id\"\n }\n }\n ]\n}\n```\n\nThis error is caused by not providing a severity identifier, which should be at\nthe `severity_id` field of the request payload. Errors like these can be mapped to\nforms, should you be integrating with the API from a user-interface.\n\n## Compatibility\n\nWe won't make breaking changes to existing API services or endpoints, but will\nexpect integrators to upgrade themselves to the latest API endpoints within 3\nmonths of us deprecating the old service.\n\nWe will make changes that are considered backwards compatible, which include:\n\n- Adding new API endpoints and services\n- Adding new properties to responses from existing API endpoints\n- Reordering properties returned from existing API endpoints\n- Adding optional request parameters to existing API endpoints\n- Altering the format or length of IDs\n- Adding new values to enums\n\nIt is important that clients are robust to these changes, to ensure reliable\nintegrations.\n\nAs an example, if you are generating a client using an openapi-generator, ensure\nthe generated client is configured to support unknown enum values, often\nconfigured via the `enumUnknownDefaultCase` parameter.\n\nWhen breaking changes are unavoidable, we'll create a new service version on a\nseparate path, and run them in parallel.\n\nFor example:\n\n- https://api.incident.io/v1/incidents\n- https://api.incident.io/v2/incidents\n\nFor any questions, email support@incident.io.\n" title: incident.io version: 1.0.0 servers: - url: https://api.incident.io security: - BearerAuth: [] tags: - description: >- View and manage call routes: phone numbers your customers can call to reach whoever is on call. Use these endpoints to read how a route is configured, and to change who it pages, the language it speaks to callers, and which number responders see when it calls them. List and edit call routes here. Create and delete them in the dashboard. name: Call Route Options V2 paths: /v2/call_routes/{call_route_id}/options: post: tags: - Call Route Options V2 summary: Create description: >- Add an option to a call route's phone-tree menu. Callers hear the menu instead of being routed down the route's own path, so adding the first option clears that path. Every plan allows a single option. A menu of two or more options is not on every plan, so get in touch if you need one enabled. operationId: Call Routes V2_CreateOption parameters: - description: The call route to add this option to example: 01FCNDV6P870EA6S7TK1DSYDG0 in: path name: call_route_id required: true schema: description: The call route to add this option to example: 01FCNDV6P870EA6S7TK1DSYDG0 type: string requestBody: content: application/json: example: digit: '1' path: - id: 01FCNDV6P870EA6S7TK1DSYDG0 level: targets: - id: lawrencejones schedule_mode: currently_on_call selected_rota_id: 01FCNDV6P870EA6S7TK1DSYDG0 type: schedule urgency: high type: level voicemail: greeting_text: >- Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded. prompt: For an urgent production outage, press 1 schema: $ref: '#/components/schemas/CallRoutesCreateOptionPayloadV2' required: true responses: '201': content: application/json: example: option: digit: '1' id: 01FCNDV6P870EA6S7TK1DSYDG0 path: - id: 01FCNDV6P870EA6S7TK1DSYDG0 level: targets: - id: lawrencejones schedule_mode: currently_on_call selected_rota_id: 01FCNDV6P870EA6S7TK1DSYDG0 type: schedule urgency: high type: level voicemail: greeting_text: >- Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded. prompt: For an urgent production outage, press 1 schema: $ref: '#/components/schemas/CallRoutesCreateOptionResultV2' description: Created response. '400': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: >- invalid_request_error: There was a problem with the request, like a missing header or querying a resource that doesn't exist. '401': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: 'authentication_error: Authentication failed.' '403': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: >- resource_forbidden: Access to this resource is forbidden for the authenticated user. '404': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: 'not_found: The referenced resource could not be found.' '405': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: >- method_not_allowed: The endpoint does not support this operation for the specified resource. '406': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: >- not_acceptable: Requested a media type this endpoint does not support. '408': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: |- request_timeout: The request took too long to process. client_timeout: The request was cancelled by the client. '409': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: >- conflict: Request conflicted with current state of the resource, likely a concurrent update. '412': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: 'precondition_failed: A required condition hasn''t been met.' '413': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: 'payload_too_large: The request payload is too large.' '422': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: >- validation_error: A required field was not provided, or the provided data was invalid. '429': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: >- too_many_requests: Too many requests hit the API too quickly. We recommend an exponential backoff of your requests. rate_limit_reached: The rate limit associated with this resource or API key has been exceeded. Try again later. '500': content: application/json: schema: $ref: '#/components/schemas/ErrorResponse' description: 'api_error: Something went wrong and has been reported internally.' components: schemas: CallRoutesCreateOptionPayloadV2: example: digit: '1' path: - id: 01FCNDV6P870EA6S7TK1DSYDG0 level: targets: - id: lawrencejones schedule_mode: currently_on_call selected_rota_id: 01FCNDV6P870EA6S7TK1DSYDG0 type: schedule urgency: high type: level voicemail: greeting_text: >- Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded. prompt: For an urgent production outage, press 1 properties: digit: description: The keypad digit a caller presses to choose this option enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' example: '1' type: string path: description: Who to page when a caller chooses this option example: - id: 01FCNDV6P870EA6S7TK1DSYDG0 level: targets: - id: lawrencejones schedule_mode: currently_on_call selected_rota_id: 01FCNDV6P870EA6S7TK1DSYDG0 type: schedule urgency: high type: level voicemail: greeting_text: >- Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded. items: $ref: '#/components/schemas/CallRoutePathNodePayloadV2' type: array prompt: description: >- What we read out to offer this option, via text-to-speech in the route's language, exactly as written example: For an urgent production outage, press 1 maxLength: 250 type: string required: - digit - prompt - path type: object CallRoutesCreateOptionResultV2: example: option: digit: '1' id: 01FCNDV6P870EA6S7TK1DSYDG0 path: - id: 01FCNDV6P870EA6S7TK1DSYDG0 level: targets: - id: lawrencejones schedule_mode: currently_on_call selected_rota_id: 01FCNDV6P870EA6S7TK1DSYDG0 type: schedule urgency: high type: level voicemail: greeting_text: >- Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded. prompt: For an urgent production outage, press 1 properties: option: $ref: '#/components/schemas/CallRouteOptionV2' required: - option type: object ErrorResponse: example: debug: message: 'Something broke: and something else: and something else' stacktrace: - thing.go:123 errors: - code: trial_expired message: Default incident call link must be a valid URL metadata: abc123: abc123 source: field: default_call_url pointer: /settings/default_call_url rate_limit: limit: 100 name: client_ip remaining: 98 retry_after: '2020-01-01T00:00:00Z' request_id: 2T1p0e3j status: 408 type: invalid_request_error properties: debug: $ref: '#/components/schemas/ErrorDebug' errors: description: List of errors that caused this request to fail example: - code: trial_expired message: Default incident call link must be a valid URL metadata: abc123: abc123 source: field: default_call_url pointer: /settings/default_call_url items: $ref: '#/components/schemas/ErrorSingle' type: array rate_limit: $ref: '#/components/schemas/ErrorRateLimit' request_id: description: Unique identifier of the request example: 2T1p0e3j type: string status: description: HTTP status of the response example: 408 format: int64 type: integer type: description: Machine-readable identifier for the general category of error enum: - invalid_request_error - authentication_error - resource_forbidden - not_found - not_acceptable - method_not_allowed - request_timeout - conflict - precondition_failed - payload_too_large - validation_error - too_many_requests - api_error - rate_limit_reached - client_timeout example: invalid_request_error type: string required: - type - status - request_id - errors type: object CallRoutePathNodePayloadV2: example: id: 01FCNDV6P870EA6S7TK1DSYDG0 level: targets: - id: lawrencejones schedule_mode: currently_on_call selected_rota_id: 01FCNDV6P870EA6S7TK1DSYDG0 type: schedule urgency: high type: level voicemail: greeting_text: >- Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded. properties: id: description: Unique identifier for this node. Omit it and we'll generate one. example: 01FCNDV6P870EA6S7TK1DSYDG0 type: string level: $ref: '#/components/schemas/CallRoutePathNodeLevelV2' type: description: |- The type of this node. Available types are: * level: page a set of targets, rotating between them * voicemail: record a message from the caller enum: - level - voicemail example: level type: string voicemail: $ref: '#/components/schemas/CallRoutePathNodeVoicemailV2' required: - type type: object CallRouteOptionV2: description: >- One entry in a call route's phone-tree menu: the digit a caller presses, the prompt we read out to offer it, and who we page when they choose it. properties: digit: description: The keypad digit a caller presses to choose this option enum: - '1' - '2' - '3' - '4' - '5' - '6' - '7' - '8' - '9' example: '1' type: string id: description: Unique identifier for this option example: 01FCNDV6P870EA6S7TK1DSYDG0 type: string path: description: Who we page when a caller chooses this option example: - id: 01FCNDV6P870EA6S7TK1DSYDG0 level: targets: - id: lawrencejones schedule_mode: currently_on_call selected_rota_id: 01FCNDV6P870EA6S7TK1DSYDG0 type: schedule urgency: high type: level voicemail: greeting_text: >- Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded. items: $ref: '#/components/schemas/CallRoutePathNodeV2' type: array prompt: description: >- What we read out to offer this option, via text-to-speech in the route's language, exactly as written example: For an urgent production outage, press 1 maxLength: 250 type: string required: - id - digit - prompt - path type: object ErrorDebug: example: message: 'Something broke: and something else: and something else' stacktrace: - thing.go:123 properties: message: description: Original internal error message example: 'Something broke: and something else: and something else' type: string stacktrace: description: Stacktrace of the error, if applicable example: - thing.go:123 items: example: thing.go:123 type: string type: array required: - message - stacktrace type: object ErrorSingle: example: code: trial_expired message: Default incident call link must be a valid URL metadata: abc123: abc123 source: field: default_call_url pointer: /settings/default_call_url properties: code: description: Machine-readable identifier for this specific error example: trial_expired type: string message: description: Human readable description of the error example: Default incident call link must be a valid URL type: string metadata: additionalProperties: example: abc123 type: string description: Additional metadata about the error, keyed by a string identifier example: abc123: abc123 type: object source: $ref: '#/components/schemas/ErrorSource' required: - code - message type: object ErrorRateLimit: example: limit: 100 name: client_ip remaining: 98 retry_after: '2020-01-01T00:00:00Z' properties: limit: description: >- The maximum number of requests that the consumer is permitted to make per minute example: 100 format: int64 type: integer name: description: Which rate limit was exceeded example: client_ip type: string remaining: description: The number of requests remaining in the current rate limit window example: 98 format: int64 type: integer retry_after: description: >- When the client can retry, as an RFC3339 timestamp in UTC. Prefer the Retry-After response header, which carries the same instant as a number of seconds example: '2020-01-01T00:00:00Z' type: string required: - name - limit - remaining - retry_after type: object CallRoutePathNodeLevelV2: description: >- The targets a level pages. We call each target for 30 seconds, rotating to the next after 60 seconds, and move to the next node if nobody acknowledges within 5 minutes. Those timings are fixed for call routes. example: targets: - id: lawrencejones schedule_mode: currently_on_call selected_rota_id: 01FCNDV6P870EA6S7TK1DSYDG0 type: schedule urgency: high properties: targets: description: The users and schedules to page example: - id: lawrencejones schedule_mode: currently_on_call selected_rota_id: 01FCNDV6P870EA6S7TK1DSYDG0 type: schedule urgency: high items: $ref: '#/components/schemas/CallRouteTargetV2' type: array required: - targets type: object CallRoutePathNodeVoicemailV2: description: >- Records a message from the caller, and enriches the resulting alert with the transcript. example: greeting_text: >- Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded. properties: greeting_text: description: >- What we read to the caller before recording, via text-to-speech in the route's language, exactly as written example: >- Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded. maxLength: 250 type: string required: - greeting_text type: object CallRoutePathNodeV2: description: >- A single step in a call route's path. Levels page a set of targets, and a trailing voicemail node records a message from the caller. A path made up of only a voicemail node sends callers straight to voicemail without paging anyone. example: id: 01FCNDV6P870EA6S7TK1DSYDG0 level: targets: - id: lawrencejones schedule_mode: currently_on_call selected_rota_id: 01FCNDV6P870EA6S7TK1DSYDG0 type: schedule urgency: high type: level voicemail: greeting_text: >- Sorry, no one is available to take your call. Please leave a message after the tone. This call will be recorded. properties: id: description: Unique identifier for this node example: 01FCNDV6P870EA6S7TK1DSYDG0 type: string level: $ref: '#/components/schemas/CallRoutePathNodeLevelV2' type: description: |- The type of this node. Available types are: * level: page a set of targets, rotating between them * voicemail: record a message from the caller enum: - level - voicemail example: level type: string voicemail: $ref: '#/components/schemas/CallRoutePathNodeVoicemailV2' required: - id - type type: object ErrorSource: example: field: default_call_url pointer: /settings/default_call_url properties: field: description: Field name that is the source of the error example: default_call_url type: string pointer: description: JSON pointer to the request field that is the source of the error example: /settings/default_call_url type: string required: - field - pointer type: object CallRouteTargetV2: description: Someone a call route pages when a call comes in. example: id: lawrencejones schedule_mode: currently_on_call selected_rota_id: 01FCNDV6P870EA6S7TK1DSYDG0 type: schedule urgency: high properties: id: description: Uniquely identifies an entity of this type example: lawrencejones type: string schedule_mode: description: >- Only set for schedule targets, this specifies which users to fetch from the schedule. Use currently_on_call to notify whoever is on call right now across the schedule, all_users to notify every user attached to the schedule, or all_users_for_rota / currently_on_call_for_rota / next_on_call_for_rota to scope to a specific rota (in which case selected_rota_id is required). next_on_call notifies whoever is next on call across the schedule. enum: - currently_on_call - all_users_for_rota - all_users - currently_on_call_for_rota - next_on_call_for_rota - next_on_call - '' example: currently_on_call type: string selected_rota_id: description: >- For schedule targets, identifies which rota on the schedule the schedule_mode applies to. Required when schedule_mode is all_users_for_rota, currently_on_call_for_rota, or next_on_call_for_rota; must be omitted for other schedule_mode values. example: 01FCNDV6P870EA6S7TK1DSYDG0 type: string type: description: Whether a call route target is a user or a schedule enum: - user - schedule example: schedule type: string x-public-api-version: v2 urgency: description: The urgency of this escalation path target enum: - high - low example: high type: string required: - type - id - urgency type: object securitySchemes: BearerAuth: type: http scheme: bearer description: API key from your incident.io dashboard (Settings → API keys) ````