MyRapidi
MyRapidi

Search our Wiki

REST API Transfers Update Transfer

If you want to update a transfer you need to specify its transfer code, as well as the parameters you want to update.

Examples are provided in JSON format.

NOTE: Remember to substitute the token (after Bearer) and the service id (the "xyz" below) to your own token and service id.

JSON:

Edit transfer 4 from service with id [SERVICE ID], with a new description "updated transfer description".

curl -H "Authorization: Bearer [API SECURITY TOKEN]"
  -H "Content-Type: application/json"
  -H "Accept: application/json"
  -X PATCH
  -d "{\"description\":\"updated transfer description\"} }}"
  http://staging.myrapidi.com/api/v2/service/[SERVICE ID]/transfers/4

The output for this example would be:

{
  "id": 4,
  "code": "NEW_TRANSFER_CODE",
  "description": "updated transfer description",
  "status": "Implementing",
  "group": null,
  "source": null,
  "source_layout": null,
  "destination": null,
  "destination_layout": null,
  "source_table": null,
  "destination_table": null,
  "link_storage": null,
  "enabled": null,
  "update": null,
  "add": null,
  "delete": null,
  "actions": null,
  "move": null,
  "delete_all": null,
  "autogenerate_key": null,
  "disable_dest_lookup": null,
  "all_fields": false,
  "continue_on_error": null,
  "comments": []
}