{"_id":"5769659547693a0e00002b85","editedParams2":true,"version":{"_id":"55773a5ba042551900b002ce","project":"55773a5ba042551900b002cb","__v":18,"createdAt":"2015-06-09T19:11:23.764Z","releaseDate":"2015-06-09T19:11:23.764Z","categories":["55773a5ca042551900b002cf","55773a6ce6063e0d00481380","55773ab007e7110d001043ec","55773abaa042551900b002d5","55773ac207e7110d001043ed","55773acb07e7110d001043ee","55773ad3a042551900b002d6","55773adce6063e0d00481383","55773ae4a042551900b002d7","55773af307e7110d001043ef","55773af907e7110d001043f0","55773b0407e7110d001043f1","563a4f7ad25e8919005f3f39","563a4fcaa19edf0d00972321","564a70dc4cd0521700523edf","564b797bcc472d0d00da9435","564b855b766d4923004e1fd1","59cd4b81935249001c77c48e"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"Motherboard","version_clean":"1.0.0","version":"1"},"__v":1,"category":{"_id":"55773af307e7110d001043ef","__v":6,"version":"55773a5ba042551900b002ce","pages":["564b86fe7a18b00d00a21bec","564b8711d768500d0088b712","564b87210a68360d00a3a536","564b87367a18b00d00a21bef","564b874a7a18b00d00a21bf2","564b876425d7060d005c58a4"],"project":"55773a5ba042551900b002cb","sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-09T19:13:55.100Z","from_sync":false,"order":10,"slug":"subscriptions-api","title":"Subscriptions API"},"parentDoc":null,"user":"546d17e2eb9cfd1400dd4529","project":"55773a5ba042551900b002cb","editedParams":true,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-06-21T16:04:37.152Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"examples":{"codes":[]},"method":"put","results":{"codes":[{"language":"json","status":200,"name":"","code":"{\n  \"code\": 200,\n  \"status\": \"success\",\n  \"data\": [\n    {\n      \"subscription_id\": 26,\n      \"application_id\": 7,\n      \"subscription_created\": \"2016-06-20T18:51:05+0000\",\n      \"subscription_updated\": \"2016-06-20T18:51:05+0000\",\n      \"subscription_event\": \"ranking.run\",\n      \"subscription_label\": \"Subscription\",\n      \"subscription_url\": \"http://requestb.in/12wd1if1\",\n      \"subscription_retry_attempts\": 10,\n      \"subscription_retry_delay\": 60,\n      \"subscription_token\": \"a_token\",\n      \"subscription_email_notifications\": false\n    }\n  ]\n}"}]},"settings":"","auth":"required","params":[{"_id":"566ba14885dc790d0062c0f2","ref":"","in":"body","required":true,"desc":"The URL for the webhook to be POSTed","default":"","type":"string","name":"url"},{"_id":"566ba14885dc790d0062c0f1","ref":"","in":"body","required":false,"desc":"The number of retries","default":"10","type":"int","name":"retries"},{"_id":"566ba14885dc790d0062c0f0","ref":"","in":"body","required":false,"desc":"The length of time between retries","default":"60","type":"int","name":"retries_delay"},{"_id":"566ba14885dc790d0062c0ef","ref":"","in":"body","required":false,"desc":"Whether to receive email notifications for failed deliveries","default":"","type":"boolean","name":"email_notifications"},{"_id":"566ba14885dc790d0062c0ee","ref":"","in":"body","required":false,"desc":"An optional token to be passed as a query parameter","default":"","type":"string","name":"token"},{"_id":"56e3111600383b0e00d46d93","ref":"","in":"body","required":false,"desc":"A pipe delimited list of events to subscribe","default":"","type":"string","name":"event"},{"_id":"58b0789cd583072f009da412","ref":"","in":"path","required":true,"desc":"The subscription_id of the subscription to be edited","default":"","type":"int","name":"subscription_id"}],"url":"/subscriptions"},"isReference":true,"order":4,"body":"The Subscription Listing method returns an array of subscription objects for the authenticated user.\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Only subscriptions created by the authenticating user will be displayed\"\n}\n[/block]\nYou may also manage subscriptions through the [apps.api.triathlon.org](https://apps.api.triathlon.org/) management portal.","excerpt":"","slug":"update-subscription","type":"endpoint","title":"Update Subscription"}

putUpdate Subscription


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

subscription_id:
required
integer
The subscription_id of the subscription to be edited

Body Params

url:
required
string
The URL for the webhook to be POSTed
retries:
integer10
The number of retries
retries_delay:
integer60
The length of time between retries
email_notifications:
boolean
Whether to receive email notifications for failed deliveries
token:
string
An optional token to be passed as a query parameter
event:
string
A pipe delimited list of events to subscribe

Result Format


Documentation

The Subscription Listing method returns an array of subscription objects for the authenticated user. [block:callout] { "type": "danger", "title": "Only subscriptions created by the authenticating user will be displayed" } [/block] You may also manage subscriptions through the [apps.api.triathlon.org](https://apps.api.triathlon.org/) management portal.

User Information

Try It Out

put
{{ tryResults.results }}
Method{{ tryResults.method }}
Request Headers
{{ tryResults.requestHeaders }}
URL{{ tryResults.url }}
Request Data
{{ tryResults.data }}
Status
Response Headers
{{ tryResults.responseHeaders }}