This shows you the differences between two versions of the page.
| — |
web_api:reseller:event_notification_url [2010/07/26 15:24] (current) Jose Lopez created |
||
|---|---|---|---|
| Line 1: | Line 1: | ||
| + | ====== Subuser Event Notification Url ====== | ||
| + | Subuser event notification url function almost exactly the same way as the regular user [[web_api:event_notification_url|event notification url]] of the SendGrid Web API. The main difference here is that the possible actions outlined in the [[web_api:event_notification_url|event notification url section]] (get/delete) are defined as a "task" in the reseller portion. | ||
| + | |||
| + | The following shows the available actions: | ||
| + | |||
| + | ===== Retrieve ===== | ||
| + | |||
| + | ====Parameters==== | ||
| + | There are **two** required parameters for the reseller event notification url calls. | ||
| + | |||
| + | ^ Parameter ^ Required ^ Requirements ^ Description ^ | ||
| + | | user | <html><span style="color:#FF0000">Required</span></html> | Subuser must be registered under you. | The event notification url | | ||
| + | | task | <html><span style="color:#FF0000">Required</span></html> | Must be set to "**get**". | This will allow you to retrieve the event notification url for the specified user. | | ||
| + | |||
| + | ==== XML ==== | ||
| + | **Command** | ||
| + | Get your subuser's event notification url in XML format: | ||
| + | <code> | ||
| + | https://sendgrid.com/api/user.eventposturl.xml?api_user=youremail@domain.com&api_key=secureSecret&task=get&user=subuser@domain.com | ||
| + | </code> | ||
| + | |||
| + | **Return** | ||
| + | <code xml> | ||
| + | <url>http://www.SubUserPostUrlHere.com</url> | ||
| + | </code> | ||
| + | |||
| + | ==== JSON ==== | ||
| + | **Command** | ||
| + | <code> | ||
| + | https://sendgrid.com/api/user.eventposturl.json?api_user=youremail@domain.com&api_key=secureSecret&task=get&user=subuser@domain.com | ||
| + | </code> | ||
| + | |||
| + | **Return** | ||
| + | <code> | ||
| + | [{"url":"http:\/\/www.SubUserPostUrlHere.com"}] | ||
| + | </code> | ||
| + | |||
| + | ===== Update / Set Url ===== | ||
| + | The event notification url can be updated/set with the //set// action. | ||
| + | ====Parameters==== | ||
| + | There are **three** required parameters for the reseller to set or update the event notification url calls. | ||
| + | |||
| + | ^ Parameter ^ Required ^ Requirements ^ Description ^ | ||
| + | | user | <html><span style="color:#FF0000">Required</span></html> | Subuser must be registered under you. | The username of the subuser | | ||
| + | | task | <html><span style="color:#FF0000">Required</span></html> | Must be set to "**set**". | This will allow you to retrieve the event notification url for the specified user. | | ||
| + | | url | <html><span style="color:#FF0000">Required</span></html> | The notification url | This is the new event notification url | | ||
| + | |||
| + | ==== XML ==== | ||
| + | **Command** | ||
| + | Set your subuser's event notification url and receive response in XML format: | ||
| + | <code> | ||
| + | https://sendgrid.com/api/user.eventposturl.xml?api_user=youremail@domain.com&api_key=secureSecret&task=set&user=subuser@domain.com&url=http://www.SubUserPostUrlHere.com | ||
| + | </code> | ||
| + | |||
| + | **Return** | ||
| + | <code xml> | ||
| + | <result> | ||
| + | <message>success</message> | ||
| + | </result> | ||
| + | </code> | ||
| + | |||
| + | ==== JSON ==== | ||
| + | **Command** | ||
| + | <code> | ||
| + | https://sendgrid.com/api/user.eventposturl.json?api_user=youremail@domain.com&api_key=secureSecret&task=set&user=subuser@domain.com&url=http://www.SubUserPostUrlHere.com | ||
| + | </code> | ||
| + | |||
| + | **Return** | ||
| + | <code> | ||
| + | {"message":"success"} | ||
| + | </code> | ||
| + | |||
| + | ===== Delete ===== | ||
| + | The event notification url can be deleted with the //delete// action. | ||
| + | |||
| + | ====Parameters==== | ||
| + | There are **two** required parameters for the reseller to delete the event notification url calls. | ||
| + | |||
| + | ^ Parameter ^ Required ^ Requirements ^ Description ^ | ||
| + | | user | <html><span style="color:#FF0000">Required</span></html> | Subuser must be registered under you. | The username of the subuser | | ||
| + | | task | <html><span style="color:#FF0000">Required</span></html> | Must be set to "**delete**". | This will allow you to delete the event notification url for the specified subuser. | | ||
| + | |||
| + | ==== XML ==== | ||
| + | **Command** | ||
| + | Delete your post notification url and receives response message in XML format: | ||
| + | <code> | ||
| + | https://sendgrid.com/api/user.eventposturl.xml?api_user=youremail@domain.com&api_key=secureSecret&task=delete&user=subuser@domain.com | ||
| + | </code> | ||
| + | |||
| + | **Return** | ||
| + | <code xml> | ||
| + | <result> | ||
| + | <message>success</message> | ||
| + | </result> | ||
| + | </code> | ||
| + | |||
| + | ==== JSON ==== | ||
| + | **Command** | ||
| + | <code> | ||
| + | https://sendgrid.com/api/user.eventposturl.json?api_user=youremail@domain.com&api_key=secureSecret&task=delete&user=subuser@domain.com | ||
| + | </code> | ||
| + | |||
| + | **Return** | ||
| + | <code> | ||
| + | {"message":"success"} | ||
| + | </code> | ||