Update an AMB template

PATCH

api

accounts

{account_id}

amb_primitive_templates

{id}

Update an AMB template

curl --request PATCH \
  --url https://app.tied.com/api/v1/accounts/{account_id}/amb_primitive_templates/{id} \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "amb_primitive_template": {
    "name": "Plan comparison rich link",
    "data": {
      "richLink": {
        "title": "Compare Tied plans",
        "url": "https://tied.com/pricing",
        "image": "https://app.tied.com/brand-assets/tied-app-icon.png"
      }
    }
  }
}
'

import requests

url = "https://app.tied.com/api/v1/accounts/{account_id}/amb_primitive_templates/{id}"

payload = { "amb_primitive_template": {
        "name": "Plan comparison rich link",
        "data": { "richLink": {
                "title": "Compare Tied plans",
                "url": "https://tied.com/pricing",
                "image": "https://app.tied.com/brand-assets/tied-app-icon.png"
            } }
    } }
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amb_primitive_template: {
      name: 'Plan comparison rich link',
      data: {
        richLink: {
          title: 'Compare Tied plans',
          url: 'https://tied.com/pricing',
          image: 'https://app.tied.com/brand-assets/tied-app-icon.png'
        }
      }
    }
  })
};

fetch('https://app.tied.com/api/v1/accounts/{account_id}/amb_primitive_templates/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://app.tied.com/api/v1/accounts/{account_id}/amb_primitive_templates/{id}")

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

request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amb_primitive_template\": {\n    \"name\": \"Plan comparison rich link\",\n    \"data\": {\n      \"richLink\": {\n        \"title\": \"Compare Tied plans\",\n        \"url\": \"https://tied.com/pricing\",\n        \"image\": \"https://app.tied.com/brand-assets/tied-app-icon.png\"\n      }\n    }\n  }\n}"

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

package main

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

func main() {

	url := "https://app.tied.com/api/v1/accounts/{account_id}/amb_primitive_templates/{id}"

	payload := strings.NewReader("{\n  \"amb_primitive_template\": {\n    \"name\": \"Plan comparison rich link\",\n    \"data\": {\n      \"richLink\": {\n        \"title\": \"Compare Tied plans\",\n        \"url\": \"https://tied.com/pricing\",\n        \"image\": \"https://app.tied.com/brand-assets/tied-app-icon.png\"\n      }\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("api_access_token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

{
  "account_id": 1,
  "name": "Plan comparison rich link",
  "data": {
    "richLink": {
      "title": "Compare Tied plans",
      "url": "https://tied.com/pricing",
      "image": "https://app.tied.com/brand-assets/tied-app-icon.png"
    }
  },
  "id": 1,
  "user_id": 1,
  "primitive_type": "rich_link",
  "created_at": "2026-09-21T04:30:46.425Z",
  "updated_at": "2026-09-21T04:30:46.444Z"
}

{
  "error": "Resource could not be found"
}

{
  "error": "Resource could not be found"
}

{
  "message": "Url has already been taken",
  "attributes": [
    "url"
  ]
}

Authorizations

api_access_token

string

header

required

This token can be obtained by visiting the profile page or via rails console. Provides access to endpoints based on the user permissions levels. This token can be saved by an external system when user is created via API, to perform activities on behalf of the user.

Path Parameters

integer

required

The numeric ID of the saved primitive template.

Example:

1

Body

application/json

amb_primitive_template

object

required

The template to save.

Show child attributes

Response

Success

integer

The numeric ID of the template.

account_id

integer

The account the template belongs to.

user_id

integer | null

The agent who saved it.

primitive_type

enum<string>

Which Apple Messages primitive this template builds.

Available options:

rich_link,

list_picker,

time_picker,

form,

pay,

oauth,

imessage_extension,

simple_message

name

string

What agents see in the composer. Up to 100 characters.

data

object

The primitive payload, in the shape Apple's schema for that primitive expects — the same JSON the composer builds.

created_at

string

ISO-8601 timestamp.

updated_at

string

ISO-8601 timestamp.

Update an AMB template

curl --request PATCH \
  --url https://app.tied.com/api/v1/accounts/{account_id}/amb_primitive_templates/{id} \
  --header 'Content-Type: application/json' \
  --header 'api_access_token: <api-key>' \
  --data '
{
  "amb_primitive_template": {
    "name": "Plan comparison rich link",
    "data": {
      "richLink": {
        "title": "Compare Tied plans",
        "url": "https://tied.com/pricing",
        "image": "https://app.tied.com/brand-assets/tied-app-icon.png"
      }
    }
  }
}
'

import requests

url = "https://app.tied.com/api/v1/accounts/{account_id}/amb_primitive_templates/{id}"

payload = { "amb_primitive_template": {
        "name": "Plan comparison rich link",
        "data": { "richLink": {
                "title": "Compare Tied plans",
                "url": "https://tied.com/pricing",
                "image": "https://app.tied.com/brand-assets/tied-app-icon.png"
            } }
    } }
headers = {
    "api_access_token": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {api_access_token: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    amb_primitive_template: {
      name: 'Plan comparison rich link',
      data: {
        richLink: {
          title: 'Compare Tied plans',
          url: 'https://tied.com/pricing',
          image: 'https://app.tied.com/brand-assets/tied-app-icon.png'
        }
      }
    }
  })
};

fetch('https://app.tied.com/api/v1/accounts/{account_id}/amb_primitive_templates/{id}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

require 'uri'
require 'net/http'

url = URI("https://app.tied.com/api/v1/accounts/{account_id}/amb_primitive_templates/{id}")

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

request = Net::HTTP::Patch.new(url)
request["api_access_token"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"amb_primitive_template\": {\n    \"name\": \"Plan comparison rich link\",\n    \"data\": {\n      \"richLink\": {\n        \"title\": \"Compare Tied plans\",\n        \"url\": \"https://tied.com/pricing\",\n        \"image\": \"https://app.tied.com/brand-assets/tied-app-icon.png\"\n      }\n    }\n  }\n}"

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

package main

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

func main() {

	url := "https://app.tied.com/api/v1/accounts/{account_id}/amb_primitive_templates/{id}"

	payload := strings.NewReader("{\n  \"amb_primitive_template\": {\n    \"name\": \"Plan comparison rich link\",\n    \"data\": {\n      \"richLink\": {\n        \"title\": \"Compare Tied plans\",\n        \"url\": \"https://tied.com/pricing\",\n        \"image\": \"https://app.tied.com/brand-assets/tied-app-icon.png\"\n      }\n    }\n  }\n}")

	req, _ := http.NewRequest("PATCH", url, payload)

	req.Header.Add("api_access_token", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

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

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

	fmt.Println(string(body))

}

{
  "account_id": 1,
  "name": "Plan comparison rich link",
  "data": {
    "richLink": {
      "title": "Compare Tied plans",
      "url": "https://tied.com/pricing",
      "image": "https://app.tied.com/brand-assets/tied-app-icon.png"
    }
  },
  "id": 1,
  "user_id": 1,
  "primitive_type": "rich_link",
  "created_at": "2026-09-21T04:30:46.425Z",
  "updated_at": "2026-09-21T04:30:46.444Z"
}

{
  "error": "Resource could not be found"
}

{
  "error": "Resource could not be found"
}

{
  "message": "Url has already been taken",
  "attributes": [
    "url"
  ]
}

Getting started

Conversations

Contacts

Inboxes and channels

Automation and routing

Reporting

Help Center

Account and access

Billing

Client API

Widget API

Receiving webhooks

Update an AMB template

Authorizations

Path Parameters

Body

Response