Available Operations Errors
 
 

Application API

Nexmo provides an Application API to allow management of your Nexmo Applications.

This API is backwards compatible with version 1. Applications created using version 1 of the API can also be managed using version 2 (this version) of the API.

Available Operations:

There are multiple versions of this API available

Version 1 | Version 2

List available applications

GET https://api.nexmo.com/v2/applications
Host https://api.nexmo.com
GET /v2/applications

Authentication

Key Description Example Default
Authorization Base64 encoded API key and secret joined by a colon.
Read more
Basic <base64> None

Query Parameter

page_size
integer

The number of applications per page

page
integer

The current page number (starts at 1)

Responses

200 Success
page_size
integer

The number of applications per page

page
integer

The current page number (starts at 1)

total_items
integer

The total number of applications

total_pages
integer

The total number of pages returned

_embedded
object

A list of applications matching your existing filters

applications
array
id
string

The application's ID

name
string

Friendly identifier for your application. This is not unique

capabilities
object

Configuration for the products available in this application

voice
object

Voice related configuration

webhooks
object
answer_url
object
address
string

The URL that Nexmo requests when a call is placed/received. Must return an NCCO

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

fallback_answer_url
object
address
string

If your answer_url is offline or returns a HTTP error code, Nexmo will make a request to a fallback_answer_url if it is set. This URL must return an NCCO.

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

event_url
object
address
string

The URL that Nexmo sends events related to your call to

http_method
string

The HTTP method used to send events to your server

messages
object

Messages / Dispatch related configuration

webhooks
object
inbound_url
object
address
string

The URL that Nexmo forwards inbound messages to on your server

http_method
string

The HTTP method used to send inbound messages to your server

status_url
object
address
string

The URL that Nexmo sends events related to your messages to

http_method
string

The HTTP method used to send events to your server (always POST)

rtc
object

RTC / Conversation Service related configuration

webhooks
object
event_url
object
address
string
http_method
string
vbc
object

Specify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This is always an empty object.

Example Responses

200 400 401 405 406
{
  "page_size": 10,
  "page": 1,
  "total_items": 6,
  "total_pages": 1,
  "_embedded": {
    "applications": [
      {
        "id": "78d335fa323d01149c3dd6f0d48968cf",
        "name": "My Application",
        "capabilities": {
          "voice": {
            "webhooks": {
              "answer_url": {
                "address": "https://example.com/webhooks/answer",
                "http_method": "POST"
              },
              "fallback_answer_url": {
                "address": "https://fallback.example.com/webhooks/answer",
                "http_method": "POST"
              },
              "event_url": {
                "address": "https://example.com/webhooks/event",
                "http_method": "POST"
              }
            }
          },
          "messages": {
            "webhooks": {
              "inbound_url": {
                "address": "https://example.com/webhooks/inbound",
                "http_method": "POST"
              },
              "status_url": {
                "address": "https://example.com/webhooks/status",
                "http_method": "POST"
              }
            }
          },
          "rtc": {
            "webhooks": {
              "event_url": {
                "address": "https://example.com/webhooks/event",
                "http_method": "POST"
              }
            }
          },
          "vbc": {}
        }
      }
    ]
  }
}
{
  "type": "https://developer.nexmo.com/api-errors/application#list-validation",
  "title": "Bad Request",
  "detail": "The request failed due to validation errors",
  "invalid_parameters": [
    {
      "name": "page_size",
      "reason": "must be between 1 and 100"
    }
  ],
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#unauthorized",
  "title": "Invalid credentials supplied",
  "detail": "You did not provide correct credentials.",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#wrong-verb",
  "title": "Request method not allowed",
  "detail": "Request method 'TRACE' not supported",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#accept-header",
  "title": "Invalid Accept header",
  "detail": "Invalid Accept header provided. Must be one of the following: 'application/json'",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}

Create an application

POST https://api.nexmo.com/v2/applications
Host https://api.nexmo.com
POST /v2/applications

Authentication

Key Description Example Default
Authorization Base64 encoded API key and secret joined by a colon.
Read more
Basic <base64> None

Request body application/json

name
string | Required

Application Name

keys
object
public_key
string

Public key

capabilities
object

Your application can use multiple products. This contains the configuration for each product. This replaces the application type from version 1 of the Application API.

voice
object

Voice application webhook config

webhooks
object

Voice application webhook config

answer_url
object

The URL that Nexmo make a request to when a call is placed/received. Must return an NCCO

address
string

The URL that Nexmo make a request to when a call is placed/received. Must return an NCCO

http_method
string

The URL that Nexmo make a request to when a call is placed/received. Must return an NCCO

Must be one of: GET or POST
fallback_answer_url
object

If your answer_url is offline or returns a HTTP error code, Nexmo will make a request to a fallback_answer_url if it is set. This URL must return an NCCO.

address
string

If your answer_url is offline or returns a HTTP error code, Nexmo will make a request to a fallback_answer_url if it is set. This URL must return an NCCO.

http_method
string

If your answer_url is offline or returns a HTTP error code, Nexmo will make a request to a fallback_answer_url if it is set. This URL must return an NCCO.

Must be one of: GET or POST
event_url
object

Nexmo will send call events (e.g. ringing, answered) to this URL

address
string

Nexmo will send call events (e.g. ringing, answered) to this URL

http_method
string

Nexmo will send call events (e.g. ringing, answered) to this URL

Must be one of: GET or POST
rtc
object

RTC / Client SDK application webhook config

webhooks
object

RTC / Client SDK application webhook config

event_url
object

Nexmo will send RTC events to this URL

address
string

Nexmo will send RTC events to this URL

http_method
string

Nexmo will send RTC events to this URL

Must be one of: GET or POST
messages
object

Messages and Dispatch application webhook config

webhooks
object

Messages and Dispatch application webhook config

inbound_url
object

Nexmo will forward inbound messages to this URL

address
string

Nexmo will forward inbound messages to this URL

http_method
string

Nexmo will forward inbound messages to this URL

Must be one of: POST
status_url
object

Nexmo will send message status updates (e.g. delivered, seen) to this URL

address
string

Nexmo will send message status updates (e.g. delivered, seen) to this URL

http_method
string

Nexmo will send message status updates (e.g. delivered, seen) to this URL

Must be one of: POST
vbc
object

Specify vbc capability to enable zero-rated calls for VBC number programmability service applications. This must be an empty object.

Responses

201 Success
id
string

The application's ID

name
string

Friendly identifier for your application. This is not unique

capabilities
object

Configuration for the products available in this application

voice
object

Voice related configuration

webhooks
object
answer_url
object
address
string

The URL that Nexmo requests when a call is placed/received. Must return an NCCO

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

fallback_answer_url
object
address
string

If your answer_url is offline or returns a HTTP error code, Nexmo will make a request to a fallback_answer_url if it is set. This URL must return an NCCO.

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

event_url
object
address
string

The URL that Nexmo sends events related to your call to

http_method
string

The HTTP method used to send events to your server

messages
object

Messages / Dispatch related configuration

webhooks
object
inbound_url
object
address
string

The URL that Nexmo forwards inbound messages to on your server

http_method
string

The HTTP method used to send inbound messages to your server

status_url
object
address
string

The URL that Nexmo sends events related to your messages to

http_method
string

The HTTP method used to send events to your server (always POST)

rtc
object

RTC / Conversation Service related configuration

webhooks
object
event_url
object
address
string
http_method
string
vbc
object

Specify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This is always an empty object.

keys
object
public_key
string
private_key
string

Example Request

{
  "name": "Demo Application"
}
{
  "name": "Demo Application",
  "keys": {
    "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCA\nKOxjsU4pf/sMFi9N0jqcSLcjxu33G\nd/vynKnlw9SENi+UZR44GdjGdmfm1\ntL1eA7IBh2HNnkYXnAwYzKJoa4eO3\n0kYWekeIZawIwe/g9faFgkev+1xsO\nOUNhPx2LhuLmgwWSRS4L5W851Xe3f\nUQIDAQAB\n-----END PUBLIC KEY-----\n"
  },
  "capabilities": {
    "voice": {
      "webhooks": {
        "answer_url": {
          "address": "https://example.com/webhooks/answer",
          "http_method": "GET"
        },
        "fallback_answer_url": {
          "address": "https://fallback.example.com/webhooks/answer",
          "http_method": "GET"
        },
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "rtc": {
      "webhooks": {
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "messages": {
      "webhooks": {
        "inbound_url": {
          "address": "https://example.com/webhooks/inbound",
          "http_method": "POST"
        },
        "status_url": {
          "address": "https://example.com/webhooks/status",
          "http_method": "POST"
        }
      }
    }
  }
}

Example Responses

201 400 401 405 406 415
{
  "id": "78d335fa323d01149c3dd6f0d48968cf",
  "name": "My Application",
  "capabilities": {
    "voice": {
      "webhooks": {
        "answer_url": {
          "address": "https://example.com/webhooks/answer",
          "http_method": "POST"
        },
        "fallback_answer_url": {
          "address": "https://fallback.example.com/webhooks/answer",
          "http_method": "POST"
        },
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "messages": {
      "webhooks": {
        "inbound_url": {
          "address": "https://example.com/webhooks/inbound",
          "http_method": "POST"
        },
        "status_url": {
          "address": "https://example.com/webhooks/status",
          "http_method": "POST"
        }
      }
    },
    "rtc": {
      "webhooks": {
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "vbc": {}
  },
  "keys": {
    "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCA\nKOxjsU4pf/sMFi9N0jqcSLcjxu33G\nd/vynKnlw9SENi+UZR44GdjGdmfm1\ntL1eA7IBh2HNnkYXnAwYzKJoa4eO3\n0kYWekeIZawIwe/g9faFgkev+1xsO\nOUNhPx2LhuLmgwWSRS4L5W851Xe3f\nUQIDAQAB\n-----END PUBLIC KEY-----\n",
    "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFA\nASCBKcwggSjAgEAAoIBAQDEPpvi+3\nRH1efQ\\nkveWzZDrNNoEXmBw61w+O\n0u/N36tJnN5XnYecU64yHzu2ByEr0\n7iIvYbavFnADwl\\nHMTJwqDQakpa3\n8/SFRnTDq3zronvNZ6nOp7S6K7pcZ\nrw/CvrL6hXT1x7cGBZ4jPx\\nqhjqY\nuJPgZD7OVB69oYOV92vIIJ7JLYwqb\n-----END PRIVATE KEY-----\n"
  }
}
{
  "type": "https://developer.nexmo.com/api-errors/application#payload-validation",
  "title": "Bad Request",
  "detail": "The request failed due to validation errors",
  "invalid_parameters": [
    {
      "name": "capabilities.voice.webhooks.answer_url.http_method",
      "reason": "must be one of: GET, POST"
    }
  ],
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#unauthorized",
  "title": "Invalid credentials supplied",
  "detail": "You did not provide correct credentials.",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#wrong-verb",
  "title": "Request method not allowed",
  "detail": "Request method 'TRACE' not supported",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#accept-header",
  "title": "Invalid Accept header",
  "detail": "Invalid Accept header provided. Must be one of the following: 'application/json'",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#content-type-header",
  "title": "Unsupported Content-Type header",
  "detail": "Unsupported Content-Type header provided. Must be one of the following: 'application/json'",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}

Get an application

GET https://api.nexmo.com/v2/applications/:id
Host https://api.nexmo.com
GET /v2/applications/:id

Authentication

Key Description Example Default
Authorization Base64 encoded API key and secret joined by a colon.
Read more
Basic <base64> None

Path Parameters

id
string | Required

The ID of the application

Responses

200 Success
id
string

The application's ID

name
string

Friendly identifier for your application. This is not unique

capabilities
object

Configuration for the products available in this application

voice
object

Voice related configuration

webhooks
object
answer_url
object
address
string

The URL that Nexmo requests when a call is placed/received. Must return an NCCO

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

fallback_answer_url
object
address
string

If your answer_url is offline or returns a HTTP error code, Nexmo will make a request to a fallback_answer_url if it is set. This URL must return an NCCO.

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

event_url
object
address
string

The URL that Nexmo sends events related to your call to

http_method
string

The HTTP method used to send events to your server

messages
object

Messages / Dispatch related configuration

webhooks
object
inbound_url
object
address
string

The URL that Nexmo forwards inbound messages to on your server

http_method
string

The HTTP method used to send inbound messages to your server

status_url
object
address
string

The URL that Nexmo sends events related to your messages to

http_method
string

The HTTP method used to send events to your server (always POST)

rtc
object

RTC / Conversation Service related configuration

webhooks
object
event_url
object
address
string
http_method
string
vbc
object

Specify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This is always an empty object.

Example Responses

200 401 404 405 406
{
  "id": "78d335fa323d01149c3dd6f0d48968cf",
  "name": "My Application",
  "capabilities": {
    "voice": {
      "webhooks": {
        "answer_url": {
          "address": "https://example.com/webhooks/answer",
          "http_method": "POST"
        },
        "fallback_answer_url": {
          "address": "https://fallback.example.com/webhooks/answer",
          "http_method": "POST"
        },
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "messages": {
      "webhooks": {
        "inbound_url": {
          "address": "https://example.com/webhooks/inbound",
          "http_method": "POST"
        },
        "status_url": {
          "address": "https://example.com/webhooks/status",
          "http_method": "POST"
        }
      }
    },
    "rtc": {
      "webhooks": {
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "vbc": {}
  }
}
{
  "type": "https://developer.nexmo.com/api-errors#unauthorized",
  "title": "Invalid credentials supplied",
  "detail": "You did not provide correct credentials.",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#not-found",
  "title": "Not Found",
  "detail": "ID 'ABC123' does not exist, or you do not have access",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#wrong-verb",
  "title": "Request method not allowed",
  "detail": "Request method 'TRACE' not supported",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#accept-header",
  "title": "Invalid Accept header",
  "detail": "Invalid Accept header provided. Must be one of the following: 'application/json'",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}

Update an application

PUT https://api.nexmo.com/v2/applications/:id
Host https://api.nexmo.com
PUT /v2/applications/:id

Authentication

Key Description Example Default
Authorization Base64 encoded API key and secret joined by a colon.
Read more
Basic <base64> None

Path Parameters

id
string | Required

The ID of the application

Request body application/json

name
string | Required

Application Name

keys
object
public_key
string

Public key

capabilities
object

Your application can use multiple products. This contains the configuration for each product. This replaces the application type from version 1 of the Application API.

voice
object

Voice application webhook config

webhooks
object

Voice application webhook config

answer_url
object

The URL that Nexmo make a request to when a call is placed/received. Must return an NCCO

address
string

The URL that Nexmo make a request to when a call is placed/received. Must return an NCCO

http_method
string

The URL that Nexmo make a request to when a call is placed/received. Must return an NCCO

Must be one of: GET or POST
fallback_answer_url
object

If your answer_url is offline or returns a HTTP error code, Nexmo will make a request to a fallback_answer_url if it is set. This URL must return an NCCO

address
string

If your answer_url is offline or returns a HTTP error code, Nexmo will make a request to a fallback_answer_url if it is set. This URL must return an NCCO

http_method
string

If your answer_url is offline or returns a HTTP error code, Nexmo will make a request to a fallback_answer_url if it is set. This URL must return an NCCO

Must be one of: GET or POST
event_url
object

Nexmo will send call events (e.g. ringing, answered) to this URL

address
string

Nexmo will send call events (e.g. ringing, answered) to this URL

http_method
string

Nexmo will send call events (e.g. ringing, answered) to this URL

Must be one of: GET or POST
rtc
object

RTC / Client SDK application webhook config

webhooks
object

RTC / Client SDK application webhook config

event_url
object

Nexmo will send RTC events to this URL

address
string

Nexmo will send RTC events to this URL

http_method
string

Nexmo will send RTC events to this URL

Must be one of: GET or POST
messages
object

Messages and Dispatch application webhook config

webhooks
object

Messages and Dispatch application webhook config

inbound_url
object

Nexmo will forward inbound messages to this URL

address
string

Nexmo will forward inbound messages to this URL

http_method
string

Nexmo will forward inbound messages to this URL

Must be one of: POST
status_url
object

Nexmo will send message status updates (e.g. delivered, seen) to this URL

address
string

Nexmo will send message status updates (e.g. delivered, seen) to this URL

http_method
string

Nexmo will send message status updates (e.g. delivered, seen) to this URL

Must be one of: POST
vbc
object

Specify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This must be an empty object.

Responses

200 Success
id
string

The application's ID

name
string

Friendly identifier for your application. This is not unique

capabilities
object

Configuration for the products available in this application

voice
object

Voice related configuration

webhooks
object
answer_url
object
address
string

The URL that Nexmo requests when a call is placed/received. Must return an NCCO

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

fallback_answer_url
object
address
string

If your answer_url is offline or returns a HTTP error code, Nexmo will make a request to a fallback_answer_url if it is set. This URL must return an NCCO.

http_method
string

The HTTP method used to fetch your NCCO from your answer_url

event_url
object
address
string

The URL that Nexmo sends events related to your call to

http_method
string

The HTTP method used to send events to your server

messages
object

Messages / Dispatch related configuration

webhooks
object
inbound_url
object
address
string

The URL that Nexmo forwards inbound messages to on your server

http_method
string

The HTTP method used to send inbound messages to your server

status_url
object
address
string

The URL that Nexmo sends events related to your messages to

http_method
string

The HTTP method used to send events to your server (always POST)

rtc
object

RTC / Conversation Service related configuration

webhooks
object
event_url
object
address
string
http_method
string
vbc
object

Specify the vbc capability to enable zero-rated calls for VBC number programmability service applications. This is always an empty object.

keys
object
public_key
string
private_key
string

Example Request

{
  "name": "Demo Application"
}
{
  "name": "Demo Application",
  "keys": {
    "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCA\nKOxjsU4pf/sMFi9N0jqcSLcjxu33G\nd/vynKnlw9SENi+UZR44GdjGdmfm1\ntL1eA7IBh2HNnkYXnAwYzKJoa4eO3\n0kYWekeIZawIwe/g9faFgkev+1xsO\nOUNhPx2LhuLmgwWSRS4L5W851Xe3f\nUQIDAQAB\n-----END PUBLIC KEY-----\n"
  },
  "capabilities": {
    "voice": {
      "webhooks": {
        "answer_url": {
          "address": "https://example.com/webhooks/answer",
          "http_method": "GET"
        },
        "fallback_answer_url": {
          "address": "https://fallback.example.com/webhooks/answer",
          "http_method": "GET"
        },
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "rtc": {
      "webhooks": {
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "messages": {
      "webhooks": {
        "inbound_url": {
          "address": "https://example.com/webhooks/inbound",
          "http_method": "POST"
        },
        "status_url": {
          "address": "https://example.com/webhooks/status",
          "http_method": "POST"
        }
      }
    }
  }
}

Example Responses

200 400 401 404 405 406 415
{
  "id": "78d335fa323d01149c3dd6f0d48968cf",
  "name": "My Application",
  "capabilities": {
    "voice": {
      "webhooks": {
        "answer_url": {
          "address": "https://example.com/webhooks/answer",
          "http_method": "POST"
        },
        "fallback_answer_url": {
          "address": "https://fallback.example.com/webhooks/answer",
          "http_method": "POST"
        },
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "messages": {
      "webhooks": {
        "inbound_url": {
          "address": "https://example.com/webhooks/inbound",
          "http_method": "POST"
        },
        "status_url": {
          "address": "https://example.com/webhooks/status",
          "http_method": "POST"
        }
      }
    },
    "rtc": {
      "webhooks": {
        "event_url": {
          "address": "https://example.com/webhooks/event",
          "http_method": "POST"
        }
      }
    },
    "vbc": {}
  },
  "keys": {
    "public_key": "-----BEGIN PUBLIC KEY-----\nMIIBIjANBgkqhkiG9w0BAQEFAAOCA\nKOxjsU4pf/sMFi9N0jqcSLcjxu33G\nd/vynKnlw9SENi+UZR44GdjGdmfm1\ntL1eA7IBh2HNnkYXnAwYzKJoa4eO3\n0kYWekeIZawIwe/g9faFgkev+1xsO\nOUNhPx2LhuLmgwWSRS4L5W851Xe3f\nUQIDAQAB\n-----END PUBLIC KEY-----\n",
    "private_key": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFA\nASCBKcwggSjAgEAAoIBAQDEPpvi+3\nRH1efQ\\nkveWzZDrNNoEXmBw61w+O\n0u/N36tJnN5XnYecU64yHzu2ByEr0\n7iIvYbavFnADwl\\nHMTJwqDQakpa3\n8/SFRnTDq3zronvNZ6nOp7S6K7pcZ\nrw/CvrL6hXT1x7cGBZ4jPx\\nqhjqY\nuJPgZD7OVB69oYOV92vIIJ7JLYwqb\n-----END PRIVATE KEY-----\n"
  }
}
{
  "type": "https://developer.nexmo.com/api-errors/application#payload-validation",
  "title": "Bad Request",
  "detail": "The request failed due to validation errors",
  "invalid_parameters": [
    {
      "name": "capabilities.voice.webhooks.answer_url.http_method",
      "reason": "must be one of: GET, POST"
    }
  ],
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#unauthorized",
  "title": "Invalid credentials supplied",
  "detail": "You did not provide correct credentials.",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#not-found",
  "title": "Not Found",
  "detail": "ID 'ABC123' does not exist, or you do not have access",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#wrong-verb",
  "title": "Request method not allowed",
  "detail": "Request method 'TRACE' not supported",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#accept-header",
  "title": "Invalid Accept header",
  "detail": "Invalid Accept header provided. Must be one of the following: 'application/json'",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#content-type-header",
  "title": "Unsupported Content-Type header",
  "detail": "Unsupported Content-Type header provided. Must be one of the following: 'application/json'",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}

Delete an application

Deleting an application cannot be undone.

DELETE https://api.nexmo.com/v2/applications/:id
Host https://api.nexmo.com
DELETE /v2/applications/:id

Authentication

Key Description Example Default
Authorization Base64 encoded API key and secret joined by a colon.
Read more
Basic <base64> None

Path Parameters

id
string | Required

The ID of the application

Example Responses

204 401 404 405 406
Success
{
  "type": "https://developer.nexmo.com/api-errors#unauthorized",
  "title": "Invalid credentials supplied",
  "detail": "You did not provide correct credentials.",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#not-found",
  "title": "Not Found",
  "detail": "ID 'ABC123' does not exist, or you do not have access",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#wrong-verb",
  "title": "Request method not allowed",
  "detail": "Request method 'TRACE' not supported",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}
{
  "type": "https://developer.nexmo.com/api-errors#accept-header",
  "title": "Invalid Accept header",
  "detail": "Invalid Accept header provided. Must be one of the following: 'application/json'",
  "instance": "797a8f199c45014ab7b08bfe9cc1c12c"
}

Errors

The following is a non-exhaustive list of error codes that may occur while using this API. These codes are in addition to any of our generic error codes.

Code Details
payload-validation

Invalid request. See invalid_parameters field for details

list-validation

Invalid request. See invalid_parameters field for details

rate-limit

The request was rate limited