REST API Transfers Delete Transfer

If you want to delete a transfer please see below for both JSON and JSONAPI example.

NOTE: Remember to substitute the token ([API SECURITY TOKEN]) and the service id (the [SERVICE ID] below) to your own token and service id.

JSON:

curl -H "Authorization: Bearer [API SECURITY TOKEN]"
  -H "Content-Type: application/json"
  -H "Accept: application/json"
  -X DELETE
  http://staging.myrapidi.com/api/v2/service/[SERVICE ID]/transfers/4

The output for JSON on successful deletion is that the response code Status: 204 No Content is returned.

For JSON the output when your deletion has failed (ex. transfer has already been deleted) is the response code Status: 404 Not Found + an error message

Example error message if the given transfer ID did not exist:

{
  "errors": [
    {
      "source": {
        "pointer": "/data/attributes/id"
      },
      "detail": "not found - could not find Transfer with id 4"
    }
  ]
}