Get shareable deep links configuration

curl --request GET \
  --url https://apix.us.amity.co/api/v3/network-settings/shareable-deep-links \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://apix.us.amity.co/api/v3/network-settings/shareable-deep-links"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://apix.us.amity.co/api/v3/network-settings/shareable-deep-links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apix.us.amity.co/api/v3/network-settings/shareable-deep-links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.us.amity.co/api/v3/network-settings/shareable-deep-links"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v3/network-settings/shareable-deep-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "domain": "myapp.com",
  "patterns": {
    "posts": "/posts/{postId}",
    "communities": "/communities/{communityId}",
    "users": "/users/{userId}",
    "livestreams": "/livestreams/{livestreamId}"
  }
}

{
  "status": "error",
  "code": 400000,
  "message": "Bad Request."
}

{
  "status": "error",
  "code": 500000,
  "message": "Unexpected error"
}

GET

api

network-settings

shareable-deep-links

Get shareable deep links configuration

curl --request GET \
  --url https://apix.us.amity.co/api/v3/network-settings/shareable-deep-links \
  --header 'Authorization: Bearer <token>'

import requests

url = "https://apix.us.amity.co/api/v3/network-settings/shareable-deep-links"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)

const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://apix.us.amity.co/api/v3/network-settings/shareable-deep-links', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://apix.us.amity.co/api/v3/network-settings/shareable-deep-links",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://apix.us.amity.co/api/v3/network-settings/shareable-deep-links"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

require 'uri'
require 'net/http'

url = URI("https://apix.us.amity.co/api/v3/network-settings/shareable-deep-links")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body

{
  "domain": "myapp.com",
  "patterns": {
    "posts": "/posts/{postId}",
    "communities": "/communities/{communityId}",
    "users": "/users/{userId}",
    "livestreams": "/livestreams/{livestreamId}"
  }
}

{
  "status": "error",
  "code": 400000,
  "message": "Bad Request."
}

{
  "status": "error",
  "code": 500000,
  "message": "Unexpected error"
}

Authorizations

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Response

Shareable deep links configuration

domain

string

required

The domain for the shareable deep links

Maximum string length: 100

Example:

"myapp.com"

patterns

object

required

Show child attributes

Update UIKit config Create shareable deep links configuration

⌘I