Add a paragraph explaining error responses for opted out recipients.

praekeltfoundation · Jan 21, 2015 · 70d1838 · 70d1838
1 parent 3e32b65
commit 70d1838
Showing 1 changed file with 4 additions and 0 deletions.
diff --git a/docs/http_api.rst b/docs/http_api.rst
@@ -98,6 +98,10 @@ The response to the PUT request is the complete Vumi Go user message
 and includes the generated Vumi ``message_id`` which should be stored
 if you wish to be able to associate events with the message later.
 
+If a message is sent to a recipient that has opted out, the response will be an
+HTTP 400 error, with the body detailing that the recipient has opted out.
+Messages sent as a reply will still go through to an opted out recipient.
+
 
 Receiving User Messages
 -----------------------