Delete a course record using the CMS API v2.4.
Method | URL |
---|---|
DELETE |
/v2/courses/{id} |
Where {id} is the ID of the course you wish to delete.
Response format | JSON |
Paginated? | No |
Rate Limited? | Yes (more information) |
This API endpoint supports the following request parameters:
Parameter | Description | Notes |
---|---|---|
api_id | The api_id is given to you with your access credentials. |
Required |
data | The URL encoded JSON data string of search parameters. | Required |
sig | The HMAC signature for this request. | Required |
https://cmsapi.cofeportal.org/v2/courses/{id}
The following search parameters can be used as part of the JSON data string:
Name | Type | Notes |
---|---|---|
diocese_id | Integer | Required |
A 200 OK
response.
If the course specified by {id} has already been previously deleted, a 410 Gone
response will occur.