{"_id":"56e98c69cbeede0e0006e56c","project":"56e29a8dd3b68d0e00b48ffa","githubsync":"","version":{"_id":"56e29a8dd3b68d0e00b48ffd","hasReference":true,"project":"56e29a8dd3b68d0e00b48ffa","__v":15,"hasDoc":true,"createdAt":"2016-03-11T10:14:37.460Z","releaseDate":"2016-03-11T10:14:37.460Z","categories":["56e29a8ed3b68d0e00b48ffe","56eb917a2e58011700afdfcc","56eb92252109011700f3ba5e","5704d4af849f721900f27835","57052a31473f900e004d5d54","5715222811537f19006aab2d","5715b57b810df00e00cc7832","5715baa9810df00e00cc7837","57180ed83a17770e009a7322","571810273a17770e009a7325","579b22d3f4ad7b190094b60e","584538ecba4f1c0f0096925e","586bb88e5602870f00ae7177","5a70407fb0a01400369583c5","5ace359e40606a0003eac1de"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"editedParams2":true,"__v":3,"editedParams":true,"parentDoc":null,"user":"56e62c36cfa58f0e00eafcfb","category":{"_id":"56eb92252109011700f3ba5e","pages":["56eb92af06e2c6190046dc8d","56ebae2543304e2900e21142"],"project":"56e29a8dd3b68d0e00b48ffa","__v":2,"version":"56e29a8dd3b68d0e00b48ffd","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2016-03-18T05:29:09.180Z","from_sync":false,"order":7,"slug":"coverage-api","title":"Coverages Lifecycle"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-03-16T16:40:09.465Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"put","results":{"codes":[{"status":200,"language":"json","code":"{\n    \"id\": \"30e89f63-f1ae-4f01-49fb-6784b5ac77a4\",\n    \"status\": \"Rejected\",\n    \"rejectedBy\": \"User\",\n    \"coverage\": {\n        \"amount\": 6.21,\n        \"currency\": \"gbp\",\n        \"rejectedAt\": \"2016-09-02T12:20:31Z\"\n    },\n    \"sellerId\": \"c56edfd7-f739-8636-770e-28d75cca312a\",\n    \"buyerId\": \"076cd9f7-b9cf-f39f-cfac-29b8a8a2efca\",\n    \"invoice\": {\n        \"Amount\": 2500,\n        \"Currency\": \"gbp\",\n        \"DueAt\": \"2016-09-30T00:00:00Z\",\n        \"IssuedAt\": \"2016-08-31T00:00:00Z\",\n        \"Number\": null\n    }\n}","name":""},{"status":400,"language":"json","code":"{\n\t\"message\" : \"Missing parameters\",\n  \"docUrl\": \"https://armadill.io/docs/errors#section-missing_param\"\n}","name":""},{"status":404,"language":"json","code":"{\n\t\"message\" : \"Resource not found\",\n  \"docUrl\": \"https://armadill.io/docs/errors#section-resource_not_found\"\n}"},{"status":401,"language":"json","code":"{\n\t\"message\" : \"Bad authentication information\",\n  \"docUrl\": \"http://docs.armadill.io/docs/errors#section-bad-authentication-information\"\n}"},{"status":304,"language":"text","code":""},{"status":408,"language":"json","code":"{\n\t\"message\" : \"Expired date stamp\",\n  \"docUrl\": \"https://armadill.io/docs/authentication\"\n}"},{"code":"{\"code\":409,\"message\":\"Cannot reject a cover with status : Rejected\",\"docUrl\":null}","language":"json","status":409}]},"settings":"","auth":"required","params":[{"_id":"56e98c69cbeede0e0006e56d","ref":"","in":"path","required":true,"desc":"The ID of coverage policy to reject","default":"","type":"string","name":"id"},{"_id":"579e564d8cc49e0e00dea8c9","ref":"","in":"header","required":true,"desc":"Your Coverage API Key, in the HTTP request headers.","default":"","type":"string","name":"apikey"}],"url":"/coverage/:id/reject"},"isReference":true,"order":4,"body":"This method allows rejection of a coverage, based on a particular quote ID. \n\nThe quote must be in 'Pending' status to be rejected. \n\nOn successful reject, the API will return the quote information as JSON, including the update status and two new fields: \n* rejectedby: a field indicating that it was the User who rejected this policy\n* rejectedat: the time that the user rejected the policy \n\nOnce the quote has been rejected, it's status cannot be changed - rejected quotes cannot be activated, for example. The quote must be re-requested and the new quote must be activated (note that the pricing may change between the quotes being issued).\n\nOnly covers in the Pending state can be rejected.","excerpt":"Rejects a coverage policy.","slug":"coverage-rejection","type":"endpoint","title":"Reject Cover"}

putReject Cover

Rejects a coverage policy.

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
string
The ID of coverage policy to reject

Headers

apikey:
required
string
Your Coverage API Key, in the HTTP request headers.

Result Format


Documentation

This method allows rejection of a coverage, based on a particular quote ID. The quote must be in 'Pending' status to be rejected. On successful reject, the API will return the quote information as JSON, including the update status and two new fields: * rejectedby: a field indicating that it was the User who rejected this policy * rejectedat: the time that the user rejected the policy Once the quote has been rejected, it's status cannot be changed - rejected quotes cannot be activated, for example. The quote must be re-requested and the new quote must be activated (note that the pricing may change between the quotes being issued). Only covers in the Pending state can be rejected.