{"metadata":{"image":[],"title":"","description":""},"api":{"url":"/apps/:app_id/deeplinks","auth":"required","examples":{"codes":[{"language":"shell","code":"curl -X POST \"https://control.pulsatehq.com/api/v1/apps/$APP_ID/deeplinks/\"\n  -H \"Authorization: Token token=$MY_ADMIN_API_TOKEN\"\n  -d '{\n      \"deeplink\": {\n          \"target\": \"target_6\",\n          \"nickname\": \"nickname_6\"\n      }\n  }'"}]},"method":"post","params":[{"name":"app_id","type":"string","default":"","desc":"App ID. It can be fetched by using \"Apps: Get All (Index)\" or \"Apps: Get One (Show)\" endpoints.","required":true,"in":"path","ref":"","_id":"57ff84cf8e087d0e0003042e"},{"name":"deeplink","type":"object","default":"","desc":"Deeplink to be created","required":true,"in":"body","ref":"","_id":"5877988de1d2bd3d002a74eb"},{"name":"deeplink.target","type":"string","default":"","desc":"Deeplinktarget, URI of the resource the deeplink points to","required":true,"in":"body","ref":"","_id":"57e4f682390bb60e0041661d"},{"name":"deeplink.nickname","type":"string","default":"","desc":"Deeplink nickname, user - friendly name of the deeplink","required":true,"in":"body","ref":"","_id":"57e4f682390bb60e0041661c"}],"results":{"codes":[{"status":200,"language":"json","code":"{\n  \"created_at\": \"2017-01-12T13:14:51.097Z\",\n  \"nickname\": \"nickname_6\",\n  \"target\": \"target_6\",\n  \"id\": \"5877814b636f6e63bd580500\"\n}","name":""},{"status":422,"language":"json","code":"{\n    \"errors\": {\n        \"nickname\": [\n            \"is already taken\"\n        ],\n        \"target\": [\n            \"is already taken\"\n        ]\n    }\n}","name":""}]},"settings":"564bbbf80cbcc91700b8171c"},"next":{"description":"","pages":[]},"title":"Deeplinks: Create One","type":"endpoint","slug":"deeplinks-create-one","excerpt":"","body":"[block:api-header]\n{\n  \"title\": \"\"\n}\n[/block]\n[Supporting iOS DeepLinks](https://pulsate.readme.io/v2.7/docs/supporting-deep-links)\n[Supporting Android DeepLinks](https://pulsate.readme.io/v2.8/docs/supporting-deep-links-1)","updates":[],"order":30,"isReference":true,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"5e4fced159815700262d28f3","parentDoc":null,"user":"54aa7f3f9bb00c0b00cb899b","__v":16,"githubsync":"","project":"54aa7f773b56130b0056c86e","category":{"sync":{"isSync":false,"url":""},"pages":["5e4fced159815700262d28c6","5e4fced159815700262d28c7","5e4fced159815700262d28c8","5e4fced159815700262d28c9","5e4fced159815700262d28ca","5e4fced159815700262d28cb","5e4fced159815700262d28cc","5e4fced159815700262d28cd","5e4fced159815700262d28ce","564c68a93eb8f81700838a25"],"title":"Pulsate CMS API","slug":"pulsate-cms-api","order":1,"from_sync":false,"reference":true,"_id":"5e4fced159815700262d289e","__v":10,"createdAt":"2015-11-17T23:47:10.058Z","project":"54aa7f773b56130b0056c86e","version":"5e4fced159815700262d2930"},"createdAt":"2016-09-23T09:49:34.864Z","version":{"version":"2.2","version_clean":"2.2.0","codename":"CMS API","is_stable":false,"is_beta":false,"is_hidden":false,"is_deprecated":false,"categories":["5e4fced159815700262d2899","55781fe35129590d003ff4f9","55781fe35129590d003ff4fa","5e4fced159815700262d289a","5e4fced159815700262d289b","5e4fced159815700262d289c","5e4fced159815700262d289d","5e4fced159815700262d289e","565b66c446118c0d00dcb0bb","56898269f8dc340d00308c13","5e4fced159815700262d289f","5e4fced159815700262d28a0","5c73dd27e8fdc000572a206a","5e4fced159815700262d28a1","5e53c04c1d11110018b56e12"],"_id":"5e4fced159815700262d2930","project":"54aa7f773b56130b0056c86e","forked_from":"55781fe25129590d003ff4f7","__v":1,"createdAt":"2015-06-10T11:30:42.700Z","releaseDate":"2015-06-10T11:30:42.700Z"}}

postDeeplinks: Create One


Definition

{{ api_url }}{{ page_api_url }}

Parameters

Path Params

app_id:
required
string
App ID. It can be fetched by using "Apps: Get All (Index)" or "Apps: Get One (Show)" endpoints.

Body Params

deeplink:
required
object
Deeplink to be created
deeplink.target:
required
string
Deeplinktarget, URI of the resource the deeplink points to
deeplink.nickname:
required
string
Deeplink nickname, user - friendly name of the deeplink

Examples


Result Format


Documentation

[block:api-header] { "title": "" } [/block] [Supporting iOS DeepLinks](https://pulsate.readme.io/v2.7/docs/supporting-deep-links) [Supporting Android DeepLinks](https://pulsate.readme.io/v2.8/docs/supporting-deep-links-1)

User Information

Try It Out

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