Delete a related course record for a given contact using the CMS API v2.4.
| Method | URL |
|---|---|
DELETE |
/v2/contacts/{contact_id}/courses/{id} |
Where {contact_id} is the ID of a contact record, and {id} is the ID of the contact's related course record you wish to delete.
NOTE: {id} is NOT the ID of the course record, but the ID of the related course record for this contact. A contact can have multiple related course instances for a given course record.
| 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/contacts/{contact_id}/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 related course specified by {id} has already been previously deleted, a 410 Gone response will occur.