Delete

DELETE 
https://api.ideal-postcodes.co.uk/v1/keys/:key/configs/:config

Permanently deletes a configuration object.

Request

Path Parameters

key stringrequired
API Key
The API Key to retrieve. Begins ak_.
Example: ak_test
config stringrequired
Configuration Name
User provided configuration object name.
Example: idpc-be

Query Parameters

user_token string
Private User Token
A secret key used for sensitive operations on your account and API Keys.
Your user token can be retrieved and managed from your accounts page.
Typically beings uk_...
Example: uk_B59ScW1p1HHouf1VqclEPZUx

Responses

200

Success

application/json

Schema

Schema

result objectrequired

deletedint32required

Possible values: >= 0

Example: 1

codeint32required

Possible values: [2000]

messagestringrequired

Possible values: [Success]

Example (auto)

{
  "result": {
    "deleted": 1
  },
  "code": 2000,
  "message": "Success"
}

400

Bad Request

application/json

Schema

Schema

codeint32required
400X type error response code
messagestringrequired
Bad request error description
errors object[]
Array [
messagestringrequired
Indicates location of error in request query or URL parameter
Example: should have required property 'type'
pathstringrequired
Indicates location of error in request query or URL parameter
Example: .query.type
errorCodestring
Example: required.openapi.validation
]

Example (auto)

{
  "code": 0,
  "message": "string",
  "errors": [
    {
      "message": "should have required property 'type'",
      "path": ".query.type",
      "errorCode": "required.openapi.validation"
    }
  ]
}

401

Unauthorized Request

application/json

Schema

Schema

codeint32required

401X type error response code

messagestringrequired

Unauthorized request error description

Example (auto)

{
  "code": 0,
  "message": "string"
}

404

Not Found

application/json

Schema

Schema

codeint32required

404X type error response code

messagestringrequired

Resource not found error description

Example (auto)

{
  "code": 0,
  "message": "string"
}

• csharp
• curl
• dart
• go
• http
• java
• javascript
• kotlin
• c
• nodejs
• objective-c
• ocaml
• php
• powershell
• python
• r
• ruby
• rust
• shell
• swift

• HTTPCLIENT
• RESTSHARP

var client = new HttpClient();
var request = new HttpRequestMessage(HttpMethod.Delete, "https://api.ideal-postcodes.co.uk/v1/keys/:key/configs/:config");
request.Headers.Add("Accept", "application/json");
var response = await client.SendAsync(request);
response.EnsureSuccessStatusCode();
Console.WriteLine(await response.Content.ReadAsStringAsync());

Request Collapse all

Base URL

https://api.ideal-postcodes.co.uk/v1

Parameters

key — pathrequired

config — pathrequired

user_token — query

ResponseClear

Click the Send API Request button above and see the response here!