Create External Contact

POST https://examplebaseURL.com/v1/api/apps/{appID}/management/create_externalcontact

Response Format

Parameter	Type	Description
code	Number	Refer to Success and Error Code
id	String	External contact id

📘

Location and Language Format

Please refer to our Open API - Get Supported Location List section for the supported country code format.

Please refer to our Open API - Get Supported Language List section for the supported language format.

Path Params

appID string required
App ID

Body Params

firstName string
First name of the external contact

lastName string
Last name of the external contact

level string Defaults to Primary
Level of the external contact. It supports Primary (Default), Secondary or Tertiary.

type string Defaults to Lead
Type of the external contact. It supports Lead (Default), Prospect, Customer or "Others"

phones object
phones object
type string
Type of the phone number of the external contact. It supports Mobile, Work, Home, or "Other".
phone string
Phone number of the external contact. Format: Country code+Phone number. For example: +85294667788. Note that "+" should be added in front of the country code.

emails object
emails object
type string
Type the email address of the external contact. It supports Work, Personal, or "Other".
email string
Email address of the external contact.

company string
Company name of the external contact.

jobTitle string
Job title of the external contact.

team string
Name of the team the external contact belongs to.

group string
Name of the group the external contact belongs to.

language string
Language is the external contact that can be used to communicate with people. It is based on the ISO 639-1 Language Codes. Example: en (Language code of English in ISO 639-1)

birthDate string
Date of birth of the external contact. Format: DD/MM/YYYY.

addresses object
addresses object
street string
Street
city string
City
state string
State

zipcode string
Zip code
country string
Country. It is represented by the two-letter country code based on ISO 3166-2.

socialContacts object
socialContacts object
key string
The social media type the external contact uses. The social media type supports Facebook, WhatsApp, WeChat, LINE, Twitter, LinkedIn, WoztellWhatsApp, WoztellFacebook, or WoztellInstagram.
value string
User name/ID of the social media used by the external contact. Format: type + id/name. The limit of the user name/ID is 100 characters.

customField object
customField object
FieldTypePicklist string
Single-select picklist. Allows the user to select one option from a list of predefined values. Automatically removes invalid options. If multiple values are present, an error is returned.
FieldTypeMultiPicklist string
Multi-select picklist. Allows the user to select multiple options from a list of predefined values. Automatically removes invalid options. Multiple values are allowed.
FieldTypeText string
Text input field. Allows the user to input any text. Maximum length is 500 characters.
FieldTypeURL string
URL input field. Allows the user to input a valid URL. Maximum length is 500 characters.
FieldTypeBoolean string
Boolean field. Allows the user to input a true or false value (case-insensitive). Only accepts true or false (case-insensitive).
FieldTypeDate string
Date field. Allows the user to input a valid date in RFC3339 format. Must be in RFC3339 format (e.g., YYYY-MM-DDTHH:MM:SSZ).
FieldTypeTime string
Time field. Allows the user to input a valid time in the format HH:MM. Must be in HH:MM format (24-hour clock).

Headers

Content-Type string
application/json

Authorization string
Bearer AppToken

Responses

200
Response body
json

400
Response body
object
code integer Defaults to 0
message string

Language

LANGUAGE: Shell

Shell: cURL Request Copy

curl --request POST \
     --url https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact \
     --header 'Authorization: Bearer AppToken' \
     --header 'Content-Type: application/json' \
     --header 'accept: application/json'

Shell: HTTPie Request Copy

$ brew install httpie
http POST https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact \
  Authorization:'Bearer AppToken' \
  Content-Type:application/json \
  accept:application/json

LANGUAGE: Node

Node: Axios Request Copy

$ npm install axios --save
import axios from 'axios';

const options = {
  method: 'POST',
  url: 'https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact',
  headers: {
    accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer AppToken'
  }
};

axios
  .request(options)
  .then(res => console.log(res.data))
  .catch(err => console.error(err));

Node: fetch Request Copy

const url = 'https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact';
const options = {
  method: 'POST',
  headers: {
    accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer AppToken'
  }
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

Node: http Request Copy

const http = require('https');

const options = {
  method: 'POST',
  hostname: 'examplebaseurl.com',
  port: null,
  path: '/v1/api/apps/appID/management/create_externalcontact',
  headers: {
    accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer AppToken'
  }
};

const req = http.request(options, function (res) {
  const chunks = [];

  res.on('data', function (chunk) {
    chunks.push(chunk);
  });

  res.on('end', function () {
    const body = Buffer.concat(chunks);
    console.log(body.toString());
  });
});

req.end();

Node: API Request Copy

$ npx api install "@cinnox2021/v7.3#45i1wk2km9l1e4hf"
import cinnox2021 from '@api/cinnox2021';

cinnox2021.createExternalContact({appID: 'appID', Authorization: 'Bearer AppToken'})
  .then(({ data }) => console.log(data))
  .catch(err => console.error(err));

LANGUAGE: Ruby

Request Copy

require 'uri'
require 'net/http'

url = URI("https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact")

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

request = Net::HTTP::Post.new(url)
request["accept"] = 'application/json'
request["Content-Type"] = 'application/json'
request["Authorization"] = 'Bearer AppToken'

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

LANGUAGE: PHP

PHP: cURL Request Copy

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer AppToken",
    "Content-Type: application/json",
    "accept: application/json"
  ],
]);

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

curl_close($curl);

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

PHP: Guzzle Request Copy

$ composer require guzzlehttp/guzzle
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact', [
  'headers' => [
    'Authorization' => 'Bearer AppToken',
    'Content-Type' => 'application/json',
    'accept' => 'application/json',
  ],
]);

echo $response->getBody();

LANGUAGE: Python

Request Copy

$ python -m pip install requests
import requests

url = "https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact"

headers = {
    "accept": "application/json",
    "Content-Type": "application/json",
    "Authorization": "Bearer AppToken"
}

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

print(response.text)

LANGUAGE: C

Request Copy

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "accept: application/json");
headers = curl_slist_append(headers, "Content-Type: application/json");
headers = curl_slist_append(headers, "Authorization: Bearer AppToken");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

LANGUAGE: C#

C#: HttpClient Request Copy

using System.Net.Http.Headers;
var client = new HttpClient();
var request = new HttpRequestMessage
{
    Method = HttpMethod.Post,
    RequestUri = new Uri("https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact"),
    Headers =
    {
        { "accept", "application/json" },
        { "Authorization", "Bearer AppToken" },
    },
};
using (var response = await client.SendAsync(request))
{
    response.EnsureSuccessStatusCode();
    var body = await response.Content.ReadAsStringAsync();
    Console.WriteLine(body);
}

C#: RestSharp Request Copy

$ dotnet add package RestSharp
using RestSharp;


var options = new RestClientOptions("https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact");
var client = new RestClient(options);
var request = new RestRequest("");
request.AddHeader("accept", "application/json");
request.AddHeader("Content-Type", "application/json");
request.AddHeader("Authorization", "Bearer AppToken");
var response = await client.PostAsync(request);

Console.WriteLine("{0}", response.Content);

LANGUAGE: C++

Request Copy

CURL *hnd = curl_easy_init();

curl_easy_setopt(hnd, CURLOPT_CUSTOMREQUEST, "POST");
curl_easy_setopt(hnd, CURLOPT_WRITEDATA, stdout);
curl_easy_setopt(hnd, CURLOPT_URL, "https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact");

struct curl_slist *headers = NULL;
headers = curl_slist_append(headers, "accept: application/json");
headers = curl_slist_append(headers, "Content-Type: application/json");
headers = curl_slist_append(headers, "Authorization: Bearer AppToken");
curl_easy_setopt(hnd, CURLOPT_HTTPHEADER, headers);

CURLcode ret = curl_easy_perform(hnd);

LANGUAGE: Clojure

Request Copy

(require '[clj-http.client :as client])

(client/post "https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact" {:headers {:Authorization "Bearer AppToken"}
                                                                                               :content-type :json
                                                                                               :accept :json})

LANGUAGE: Go

Request Copy

package main

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

func main() {

	url := "https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact"

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

	req.Header.Add("accept", "application/json")
	req.Header.Add("Content-Type", "application/json")
	req.Header.Add("Authorization", "Bearer AppToken")

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

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

	fmt.Println(string(body))

}

LANGUAGE: HTTP

Request Copy

POST /v1/api/apps/appID/management/create_externalcontact HTTP/1.1
Accept: application/json
Content-Type: application/json
Authorization: Bearer AppToken
Host: examplebaseurl.com

LANGUAGE: Java

Java: AsyncHttp Request Copy

AsyncHttpClient client = new DefaultAsyncHttpClient();
client.prepare("POST", "https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact")
  .setHeader("accept", "application/json")
  .setHeader("Content-Type", "application/json")
  .setHeader("Authorization", "Bearer AppToken")
  .execute()
  .toCompletableFuture()
  .thenAccept(System.out::println)
  .join();

client.close();

Java: java.net.http. Request Copy

HttpRequest request = HttpRequest.newBuilder()
    .uri(URI.create("https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact"))
    .header("accept", "application/json")
    .header("Content-Type", "application/json")
    .header("Authorization", "Bearer AppToken")
    .method("POST", HttpRequest.BodyPublishers.noBody())
    .build();
HttpResponse<String> response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());

Java: OkHttp. Request Copy

OkHttpClient client = new OkHttpClient();

Request request = new Request.Builder()
  .url("https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact")
  .post(null)
  .addHeader("accept", "application/json")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer AppToken")
  .build();

Response response = client.newCall(request).execute();

Java: Unirest Request Copy

HttpResponse<String> response = Unirest.post("https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact")
  .header("accept", "application/json")
  .header("Content-Type", "application/json")
  .header("Authorization", "Bearer AppToken")
  .asString();

LANGUAGE: JavaScript

JavaScript: Axios Request Copy

$ npm install axios --save
import axios from 'axios';

const options = {
  method: 'POST',
  url: 'https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact',
  headers: {
    accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer AppToken'
  }
};

axios
  .request(options)
  .then(res => console.log(res.data))
  .catch(err => console.error(err));

JavaScript: fetch Request Copy

const options = {
  method: 'POST',
  headers: {
    accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer AppToken'
  }
};

fetch('https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

JavaScript: jQuery Request Copy

const settings = {
  async: true,
  crossDomain: true,
  url: 'https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact',
  method: 'POST',
  headers: {
    accept: 'application/json',
    'Content-Type': 'application/json',
    Authorization: 'Bearer AppToken'
  },
  processData: false,
  data: undefined
};

$.ajax(settings).done(res => {
  console.log(res);
});

JavaScript: XMLHttpRequest Request Copy

const data = JSON.stringify(undefined);

const xhr = new XMLHttpRequest();
xhr.withCredentials = true;

xhr.addEventListener('readystatechange', function () {
  if (this.readyState === this.DONE) {
    console.log(this.responseText);
  }
});

xhr.open('POST', 'https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact');
xhr.setRequestHeader('accept', 'application/json');
xhr.setRequestHeader('Content-Type', 'application/json');
xhr.setRequestHeader('Authorization', 'Bearer AppToken');

xhr.send(data);

LANGUAGE: JSON

Request Copy

No JSON body

LANGUAGE: Kotlin

Request Copy

val client = OkHttpClient()

val request = Request.Builder()
  .url("https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact")
  .post(null)
  .addHeader("accept", "application/json")
  .addHeader("Content-Type", "application/json")
  .addHeader("Authorization", "Bearer AppToken")
  .build()

val response = client.newCall(request).execute()

LANGUAGE: Objectve-C

Request Copy

#import <Foundation/Foundation.h>

NSDictionary *headers = @{ @"accept": @"application/json",
                           @"Content-Type": @"application/json",
                           @"Authorization": @"Bearer AppToken" };

NSMutableURLRequest *request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:@"https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact"]
                                                       cachePolicy:NSURLRequestUseProtocolCachePolicy
                                                   timeoutInterval:10.0];
[request setHTTPMethod:@"POST"];
[request setAllHTTPHeaderFields:headers];

NSURLSession *session = [NSURLSession sharedSession];
NSURLSessionDataTask *dataTask = [session dataTaskWithRequest:request
                                            completionHandler:^(NSData *data, NSURLResponse *response, NSError *error) {
                                                if (error) {
                                                    NSLog(@"%@", error);
                                                } else {
                                                    NSHTTPURLResponse *httpResponse = (NSHTTPURLResponse *) response;
                                                    NSLog(@"%@", httpResponse);
                                                }
                                            }];
[dataTask resume];

LANGUAGE: OCaml

Request Copy

$ opam install cohttp-lwt-unix cohttp-async
open Cohttp_lwt_unix
open Cohttp
open Lwt

let uri = Uri.of_string "https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact" in
let headers = Header.add_list (Header.init ()) [
  ("accept", "application/json");
  ("Content-Type", "application/json");
  ("Authorization", "Bearer AppToken");
] in

Client.call ~headers `POST uri
>>= fun (res, body_stream) ->
  (* Do stuff with the result *)

LANGUAGE: PowerShell

PowerShell: Invoke-RestMethod Request Copy

$headers=@{}
$headers.Add("accept", "application/json")
$headers.Add("Content-Type", "application/json")
$headers.Add("Authorization", "Bearer AppToken")
$response = Invoke-RestMethod -Uri 'https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact' -Method POST -Headers $headers

PowerShell: Invoke-WebRequest Request Copy

$headers=@{}
$headers.Add("accept", "application/json")
$headers.Add("Content-Type", "application/json")
$headers.Add("Authorization", "Bearer AppToken")
$response = Invoke-WebRequest -Uri 'https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact' -Method POST -Headers $headers

LANGUAGE: R

Request Copy

library(httr)

url <- "https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact"

response <- VERB("POST", url, add_headers('Authorization' = 'Bearer AppToken'), content_type("application/json"), accept("application/json"))

content(response, "text")

LANGUAGE: Swift

Request Copy

import Foundation

let url = URL(string: "https://examplebaseurl.com/v1/api/apps/appID/management/create_externalcontact")!
var request = URLRequest(url: url)
request.httpMethod = "POST"
request.timeoutInterval = 10
request.allHTTPHeaderFields = [
  "accept": "application/json",
  "Content-Type": "application/json",
  "Authorization": "Bearer AppToken"
]

let (data, _) = try await URLSession.shared.data(for: request)
print(String(decoding: data, as: UTF8.self))

Response Example

RESPONSE: 200-Result

200-Result Copy

{
    "code": Number,
    "result": {
        "id": "string"
    },
    "cid": "string"
}

RESPONSE: 400-Result

400-Result Copy

{
  "code": 0,
  "message": "The error message from the server. Please refer to the error table."
}

Get External Contact Activity

Update External Contact

Last modified: 2025-12-12

Outline