PUT playables/forward

Forwards a playable to another user. The recipient is notified and has a choice to either obtain a copy of the playable, or to ignore the request.

Note that the copy of the drills or courses is made as and when the recipient accepts the forwarded objects, not at the time of sending the request.

Resource URL

https://www.drillster.com/api/2.1.1/playables/forward

Parameters

Field Type Description
playable
required, repeatable
String One or more playable IDs.
recipient
required, repeatable
String The email address of the recipient. It is possible to add multiple recipients.
message
optional
String An optional text message from the sender to the recipient.

If a PUT request has no body (i.e. the body is empty), it is still mandatory to include a Content-Length header (i.e. Content-Length: 0). Not all HTTP clients do this automatically. For more information, please see RFC 2616.

Response

A NoContent (204) response indicated that the playables have been forwarded.

Error responses

The following error situations are possible:

ID Response code Description
no_playables_specified 400 (Bad request) At least one playable must be specified.
unknown_playable 404 (Not found) Given playable is unknown.
inaccessible_playable 403 (Forbidden) Given playable can't be accessed.
no_recipients_specified 400 (Bad request) At least one recipient must be specified.
not_permitted_by_license 403 (Forbidden) The license of one or more playables do not allow forwarding.
drill_not_released 400 (Bad request) One or more drills have not be released yet.
invalid_recipient_email_address 400 (Bad request) The recipient email address is invalid.
invalid_recipient 400 (Bad request) Playables can't be forwarded to yourself.