Create a contact - Tied

POST

/

public

/

api

/

v1

/

inboxes

/

{inbox_identifier}

/

contacts

Create a contact

curl --request POST \
  --url https://app.tied.com/public/api/v1/inboxes/{inbox_identifier}/contacts \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "1234567890",
  "identifier_hash": "4a7f2c1e9b6d8305fe41c27a90b3d6528ecf1a04b7d29e63c85f0a12d4b7e396",
  "email": "alice@acme.inc",
  "name": "Alice",
  "phone_number": "+123456789",
  "avatar": "<string>",
  "custom_attributes": {}
}
'

import requests

url = "https://app.tied.com/public/api/v1/inboxes/{inbox_identifier}/contacts"

payload = {
    "identifier": "1234567890",
    "identifier_hash": "4a7f2c1e9b6d8305fe41c27a90b3d6528ecf1a04b7d29e63c85f0a12d4b7e396",
    "email": "alice@acme.inc",
    "name": "Alice",
    "phone_number": "+123456789",
    "avatar": "<string>",
    "custom_attributes": {}
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    identifier: '1234567890',
    identifier_hash: '4a7f2c1e9b6d8305fe41c27a90b3d6528ecf1a04b7d29e63c85f0a12d4b7e396',
    email: 'alice@acme.inc',
    name: 'Alice',
    phone_number: '+123456789',
    avatar: '<string>',
    custom_attributes: {}
  })
};

fetch('https://app.tied.com/public/api/v1/inboxes/{inbox_identifier}/contacts', 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/public/api/v1/inboxes/{inbox_identifier}/contacts")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"identifier\": \"1234567890\",\n  \"identifier_hash\": \"4a7f2c1e9b6d8305fe41c27a90b3d6528ecf1a04b7d29e63c85f0a12d4b7e396\",\n  \"email\": \"alice@acme.inc\",\n  \"name\": \"Alice\",\n  \"phone_number\": \"+123456789\",\n  \"avatar\": \"<string>\",\n  \"custom_attributes\": {}\n}"

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

package main

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

func main() {

	url := "https://app.tied.com/public/api/v1/inboxes/{inbox_identifier}/contacts"

	payload := strings.NewReader("{\n  \"identifier\": \"1234567890\",\n  \"identifier_hash\": \"4a7f2c1e9b6d8305fe41c27a90b3d6528ecf1a04b7d29e63c85f0a12d4b7e396\",\n  \"email\": \"alice@acme.inc\",\n  \"name\": \"Alice\",\n  \"phone_number\": \"+123456789\",\n  \"avatar\": \"<string>\",\n  \"custom_attributes\": {}\n}")

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

	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))

}

{
  "source_id": "sr_example",
  "pubsub_token": "pt_example",
  "id": 147,
  "name": "Dana Brooks",
  "email": "dana.brooks4821@example.com",
  "phone_number": null
}

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

Path Parameters

inbox_identifier

string

required

The identifier obtained from API inbox channel

Body

application/json

identifier

string

External identifier of the contact

Example:

"1234567890"

identifier_hash

string

Identifier hash prepared for HMAC authentication. HMAC-SHA256 of the contact identifier, keyed by the inbox HMAC token. The value above is illustrative.

Example:

"4a7f2c1e9b6d8305fe41c27a90b3d6528ecf1a04b7d29e63c85f0a12d4b7e396"

email

string

Email of the contact

Example:

"alice@acme.inc"

name

string

Name of the contact

Example:

"Alice"

phone_number

string

Phone number of the contact

Example:

"+123456789"

avatar

file

Send the form data with the avatar image binary or use the avatar_url

custom_attributes

object

Custom attributes of the customer

Example:

{}

Response

Success

id

integer

Id of the contact

source_id

string

The session identifier of the contact

name

string

Name of the contact

email

string | null

Email of the contact

pubsub_token

string

The token to be used to connect to tied websocket

Create a contact

curl --request POST \
  --url https://app.tied.com/public/api/v1/inboxes/{inbox_identifier}/contacts \
  --header 'Content-Type: application/json' \
  --data '
{
  "identifier": "1234567890",
  "identifier_hash": "4a7f2c1e9b6d8305fe41c27a90b3d6528ecf1a04b7d29e63c85f0a12d4b7e396",
  "email": "alice@acme.inc",
  "name": "Alice",
  "phone_number": "+123456789",
  "avatar": "<string>",
  "custom_attributes": {}
}
'

import requests

url = "https://app.tied.com/public/api/v1/inboxes/{inbox_identifier}/contacts"

payload = {
    "identifier": "1234567890",
    "identifier_hash": "4a7f2c1e9b6d8305fe41c27a90b3d6528ecf1a04b7d29e63c85f0a12d4b7e396",
    "email": "alice@acme.inc",
    "name": "Alice",
    "phone_number": "+123456789",
    "avatar": "<string>",
    "custom_attributes": {}
}
headers = {"Content-Type": "application/json"}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    identifier: '1234567890',
    identifier_hash: '4a7f2c1e9b6d8305fe41c27a90b3d6528ecf1a04b7d29e63c85f0a12d4b7e396',
    email: 'alice@acme.inc',
    name: 'Alice',
    phone_number: '+123456789',
    avatar: '<string>',
    custom_attributes: {}
  })
};

fetch('https://app.tied.com/public/api/v1/inboxes/{inbox_identifier}/contacts', 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/public/api/v1/inboxes/{inbox_identifier}/contacts")

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = 'application/json'
request.body = "{\n  \"identifier\": \"1234567890\",\n  \"identifier_hash\": \"4a7f2c1e9b6d8305fe41c27a90b3d6528ecf1a04b7d29e63c85f0a12d4b7e396\",\n  \"email\": \"alice@acme.inc\",\n  \"name\": \"Alice\",\n  \"phone_number\": \"+123456789\",\n  \"avatar\": \"<string>\",\n  \"custom_attributes\": {}\n}"

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

package main

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

func main() {

	url := "https://app.tied.com/public/api/v1/inboxes/{inbox_identifier}/contacts"

	payload := strings.NewReader("{\n  \"identifier\": \"1234567890\",\n  \"identifier_hash\": \"4a7f2c1e9b6d8305fe41c27a90b3d6528ecf1a04b7d29e63c85f0a12d4b7e396\",\n  \"email\": \"alice@acme.inc\",\n  \"name\": \"Alice\",\n  \"phone_number\": \"+123456789\",\n  \"avatar\": \"<string>\",\n  \"custom_attributes\": {}\n}")

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

	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))

}

{
  "source_id": "sr_example",
  "pubsub_token": "pt_example",
  "id": 147,
  "name": "Dana Brooks",
  "email": "dana.brooks4821@example.com",
  "phone_number": null
}

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