{"_id":"54ad91e35ff7ef2a009ce66a","editedParams2":true,"parentDoc":null,"editedParams":true,"user":"543532513513400800a144f4","category":{"_id":"54ad59369219922100751732","version":"54343531bfaa3d0800c4d4af","__v":10,"project":"54343170fa5527080064f449","pages":["54ad5a55f6f5b10b0066dcb7","54ad659a9219922100751754","54ad6e40921992210075176c","54ad7476921992210075178b","54ad7514f6f5b10b0066dceb","54ad91e35ff7ef2a009ce66a","54b407c773abe90b0010709b","54b410d8fed7861600c31e31","54b413dffed7861600c31e3e","54b417994f25cb1600518d19"],"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2015-01-07T16:05:10.498Z","from_sync":false,"order":8,"slug":"quick-links","title":"Quick Links"},"project":"54343170fa5527080064f449","version":{"_id":"54343531bfaa3d0800c4d4af","project":"54343170fa5527080064f449","__v":28,"forked_from":"54343170fa5527080064f44c","createdAt":"2014-10-07T18:47:13.086Z","releaseDate":"2014-10-07T18:47:13.086Z","categories":["54343531bfaa3d0800c4d4b0","543435b1edce040800409240","543435b9edce040800409241","543435bcedce040800409243","543435bfedce040800409244","543435c2edce040800409245","54370cc426469424002a6dfa","54370cf026469424002a6dfd","5437129d26469424002a6e2f","543712d226469424002a6e30","5480c8fd74904f1a00053c86","54aafc6eefb39016009e4d71","54ac1d36de18cc1400226e01","54ad59369219922100751732","54b41bcf4f25cb1600518d2c","54b533a3a806f40c0050d53c","54b54bbf96fe3c0b00d38d2a","54b688a27379a90c00f53a8a","54b699efbc1a46160005edfa","54b8191691011f0b00068804","54bfb002d03bfc0d0000e814","54bfb33ed03bfc0d0000e816","55a3e94e912a6e2300882cdb","55a56c370f354f0d00fd02a8","55e85ad034516037002e9325","5638ecb62fc5520d001a4cf9","572cba2fc310640e008f63d5","596e6e42c5b53b00509791b1"],"is_deprecated":false,"is_hidden":false,"is_beta":false,"is_stable":true,"codename":"","version_clean":"3.0.0","version":"3.0"},"__v":2,"updates":[],"next":{"pages":[],"description":""},"createdAt":"2015-01-07T20:06:59.332Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"method":"post","results":{"codes":[{"name":"","code":"{\n    \"id\": \"54X3X80XX4X05X0612XX8X40\",\n    \"targetObjectId\": \"54X3X7X4X4X05X0612XX8X3X\",\n    \"emailShare\": {\n        \"audience\": [\n            {\n                \"firstName\": \"Foo\",\n                \"lastName\": \"Bar\",\n                \"email\": \"mike:::at:::example.com\",\n                \"userId\": \"X9XXX6AXX-XX8X-0X5X-X11X61X4X7354668\"\n            }\n        ],\n        \"subject\": \"io9.mov\",\n        \"message\": \"\"\n    },\n    \"created\": 1421080587296,\n    \"sharedBy\": \"X9XXX6AXX-XX8X-0X5X-X11X61X4X7354668\",\n    \"sharedByFirstName\": \"Simon\",\n    \"sharedByLastName\": \"Smith\",\n    \"sharedByEmail\": \"simon@example.com\"\n}","language":"json","status":200}]},"auth":"required","params":[{"_id":"54b4010cd8ea260b00e4e716","ref":"","in":"body","required":true,"desc":"The ID of the QuickLink you'd like to share","default":"","type":"string","name":"targetObjectId"},{"_id":"54b4010cd8ea260b00e4e715","ref":"","in":"body","required":true,"desc":"The email sharing object that definies the email message to be sent.","default":"{         \"audience\": [             {                 \"firstName\": \"Foo\",                 \"lastName\": \"Bar\",                 \"email\": \"mike@example.com\",                 \"userId\": \"X9XXX6AXX-XX8X-0X5X-X11X61X4X7354668\"             }         ],         \"subject\": \"io9.mov\",         \"message\": \"\"     }","type":"object","name":"emailShare"}],"url":""},"isReference":false,"order":4,"body":"QuickLinks are web representations of your asset. They are designed to be easily sent and viewed without the friction of constantly uploading and downloading. They also have the added benefit of reliable playback across browsers and devices. So, if you want to share your media with someone else, this is the endpoint for doing just that!\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"// Example Request Payload\\n{\\n\\t\\\"targetObjectId\\\": \\\"54X3X7X4X4X05X0612XX8X3X\\\",\\n\\t\\\"emailShare\\\": {\\n        \\\"audience\\\": [\\n            {\\n                \\\"firstName\\\": \\\"Mike\\\",\\n                \\\"lastName\\\": \\\"Matthews\\\",\\n                \\\"email\\\": \\\"mike@example.com\\\",\\n                \\\"userId\\\": \\\"X9XXX6AXX-XX8X-0X5X-X11X61X4X7354668\\\"\\n            }\\n        ],\\n        \\\"subject\\\": \\\"io9.mov\\\",\\n        \\\"message\\\": \\\"Hey Mike! Check this out!\\\"\\n    }\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"// Example Share Object\\n{\\n    \\\"id\\\": \\\"54X3X80XX4X05X0612XX8X40\\\",\\n    \\\"targetObjectId\\\": \\\"54X3X7X4X4X05X0612XX8X3X\\\",\\n    \\\"emailShare\\\": {\\n        \\\"audience\\\": [\\n            {\\n                \\\"firstName\\\": \\\"Mike\\\",\\n                \\\"lastName\\\": \\\"Matthews\\\",\\n                \\\"email\\\": \\\"mike@example.com\\\",\\n                \\\"userId\\\": \\\"X9XXX6AXX-XX8X-0X5X-X11X61X4X7354668\\\"\\n            }\\n        ],\\n        \\\"subject\\\": \\\"io9.mov\\\",\\n        \\\"message\\\": \\\"He Mike! Check this out!\\\"\\n    },\\n    \\\"created\\\": 1421080587296,\\n    \\\"sharedBy\\\": \\\"X9XXX6AXX-XX8X-0X5X-X11X61X4X7354668\\\",\\n    \\\"sharedByFirstName\\\": \\\"Simon\\\",\\n    \\\"sharedByLastName\\\": \\\"Smith\\\",\\n    \\\"sharedByEmail\\\": \\\"simon@example.com\\\"\\n}\",\n      \"language\": \"json\"\n    }\n  ]\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"danger\",\n  \"title\": \"Make Sure To Include The Email!\",\n  \"body\": \"Be sure to include the \\\"*emailShare*\\\" object in your request payload. Its details are shown in the example above. Without​ it, we don't know who to notify about your QuickLink.\"\n}\n[/block]\n\n[block:callout]\n{\n  \"type\": \"info\",\n  \"title\": \"Check Your Email\",\n  \"body\": \"Each time your QuickLink is viewed we'll send you an email. We track all kinds of useful information related to a users interaction with your QuickLink. You can see all of this information in the analytics page of the QuickLink by clicking \\\"activity\\\" in the top menu of your QuickLink.\"\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Permissions\"\n}\n[/block]\nFor public QuickLinks, the owner of the QuickLink can share it with any email address if they have the SHARING.EXTERNAL permission. For private QuickLinks, the owner can share with any user with a MediaSilo account as long as the owner has any sharing permission.","excerpt":"","slug":"share-a-quicklink","type":"endpoint","title":"Share a QuickLink"}

postShare a QuickLink


QuickLinks are web representations of your asset. They are designed to be easily sent and viewed without the friction of constantly uploading and downloading. They also have the added benefit of reliable playback across browsers and devices. So, if you want to share your media with someone else, this is the endpoint for doing just that! [block:code] { "codes": [ { "code": "// Example Request Payload\n{\n\t\"targetObjectId\": \"54X3X7X4X4X05X0612XX8X3X\",\n\t\"emailShare\": {\n \"audience\": [\n {\n \"firstName\": \"Mike\",\n \"lastName\": \"Matthews\",\n \"email\": \"mike@example.com\",\n \"userId\": \"X9XXX6AXX-XX8X-0X5X-X11X61X4X7354668\"\n }\n ],\n \"subject\": \"io9.mov\",\n \"message\": \"Hey Mike! Check this out!\"\n }", "language": "json" } ] } [/block] [block:code] { "codes": [ { "code": "// Example Share Object\n{\n \"id\": \"54X3X80XX4X05X0612XX8X40\",\n \"targetObjectId\": \"54X3X7X4X4X05X0612XX8X3X\",\n \"emailShare\": {\n \"audience\": [\n {\n \"firstName\": \"Mike\",\n \"lastName\": \"Matthews\",\n \"email\": \"mike@example.com\",\n \"userId\": \"X9XXX6AXX-XX8X-0X5X-X11X61X4X7354668\"\n }\n ],\n \"subject\": \"io9.mov\",\n \"message\": \"He Mike! Check this out!\"\n },\n \"created\": 1421080587296,\n \"sharedBy\": \"X9XXX6AXX-XX8X-0X5X-X11X61X4X7354668\",\n \"sharedByFirstName\": \"Simon\",\n \"sharedByLastName\": \"Smith\",\n \"sharedByEmail\": \"simon@example.com\"\n}", "language": "json" } ] } [/block] [block:callout] { "type": "danger", "title": "Make Sure To Include The Email!", "body": "Be sure to include the \"*emailShare*\" object in your request payload. Its details are shown in the example above. Without​ it, we don't know who to notify about your QuickLink." } [/block] [block:callout] { "type": "info", "title": "Check Your Email", "body": "Each time your QuickLink is viewed we'll send you an email. We track all kinds of useful information related to a users interaction with your QuickLink. You can see all of this information in the analytics page of the QuickLink by clicking \"activity\" in the top menu of your QuickLink." } [/block] [block:api-header] { "type": "basic", "title": "Permissions" } [/block] For public QuickLinks, the owner of the QuickLink can share it with any email address if they have the SHARING.EXTERNAL permission. For private QuickLinks, the owner can share with any user with a MediaSilo account as long as the owner has any sharing permission.