{"_id":"585008057f41013900540884","project":"556dd000d0f4740d00380dfd","user":"550e28af11e8d00d00b803f2","parentDoc":null,"version":{"_id":"556dd000d0f4740d00380e00","project":"556dd000d0f4740d00380dfd","__v":14,"createdAt":"2015-06-02T15:47:12.583Z","releaseDate":"2015-06-02T15:47:12.583Z","categories":["556dd001d0f4740d00380e01","556e17023f11b01900a36978","556eff53fc3aa80d00e1aa67","557078cf910c090d00c43414","557078dc9ea7860d008b24ed","5571a533dbb3632100974aed","5571c4ed6d8908230061f39e","5575b9b10b81dc230069c981","5580706cbe698419008f2ca7","55a4117d53611017004387d4","58502492f744712700462b20","588279ccd63d450f00e1aa58","59e76819193831002803721e","5a6899886b88e400403c3ce5"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"2.0.0","version":"2"},"__v":2,"category":{"_id":"556e17023f11b01900a36978","__v":8,"project":"556dd000d0f4740d00380dfd","version":"556dd000d0f4740d00380e00","pages":["556e1717c9d85a1900914cda","556e1772c9d85a1900914cdd","556e19fbc9d85a1900914cee","557053d2cc189a21001ab2ee","557062f79ea7860d008b24a0","557067329ea7860d008b24ae","5579a14a507db52f00907e79","55807040be698419008f2ca5"],"sync":{"url":"","isSync":false},"reference":true,"createdAt":"2015-06-02T20:50:10.014Z","from_sync":false,"order":1,"slug":"applications","title":"Applications"},"githubsync":"","metadata":{"title":"","description":"","image":[]},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2016-12-13T14:39:01.297Z","link_external":false,"link_url":"","sync_unique":"","hidden":false,"api":{"settings":"","examples":{"codes":[{"code":"{\n  \"code\": \"PROMOFREE\"\n}","language":"json"}]},"method":"put","results":{"codes":[{"language":"json","status":204,"name":"Successfully updated","code":"Intentionally left blank"}]},"auth":"required","params":[{"_id":"585008057f41013900540885","ref":"","in":"body","required":true,"desc":"Promotion code to be applied to the Application","default":"","type":"string","name":"code"},{"_id":"58500a25555c1d1b00592fd3","ref":"","in":"header","required":true,"desc":"Authorization is required for this API.  Please use a valid credentials.","default":"Basic XXX","type":"string","name":"Authorization"},{"_id":"5850241c34b4a3190022948a","ref":"","in":"path","required":true,"desc":"Id of the application","default":"","type":"int","name":"id"}],"url":"/applications/:id/promotion"},"isReference":true,"order":7,"body":"[block:callout]\n{\n  \"type\": \"warning\",\n  \"title\": \"This is an advisor-only API.  Restrictions may apply.\"\n}\n[/block]\nYou can update an application's promotion at any point during its workflow.  If the application has already been completed and has an account number, the promotion will subsequently be applied to the account as well.","excerpt":"Change the promotion for an applicant or an account","slug":"update-an-application-promotion","type":"endpoint","title":"Update a Promotion"}

putUpdate a Promotion

Change the promotion for an applicant or an account

Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

id:
required
integer
Id of the application

Body Params

code:
required
string
Promotion code to be applied to the Application

Headers

Authorization:
required
stringBasic XXX
Authorization is required for this API. Please use a valid credentials.

Examples


Result Format


Documentation

[block:callout] { "type": "warning", "title": "This is an advisor-only API. Restrictions may apply." } [/block] You can update an application's promotion at any point during its workflow. If the application has already been completed and has an account number, the promotion will subsequently be applied to the account as well.