Skip to main content
POST
/
clients
/
me
/
integrations
/
meld
/
customers
Create Meld customer
curl --request POST \
  --url https://api.portalhq.io/api/v3/clients/me/integrations/meld/customers \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": {
    "firstName": "<string>",
    "lastName": "<string>"
  },
  "email": "jsmith@example.com",
  "phone": "<string>",
  "dateOfBirth": "2023-12-25"
}
'
import requests

url = "https://api.portalhq.io/api/v3/clients/me/integrations/meld/customers"

payload = {
"name": {
"firstName": "<string>",
"lastName": "<string>"
},
"email": "jsmith@example.com",
"phone": "<string>",
"dateOfBirth": "2023-12-25"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}

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

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
name: {firstName: '<string>', lastName: '<string>'},
email: 'jsmith@example.com',
phone: '<string>',
dateOfBirth: '2023-12-25'
})
};

fetch('https://api.portalhq.io/api/v3/clients/me/integrations/meld/customers', 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://api.portalhq.io/api/v3/clients/me/integrations/meld/customers",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'name' => [
'firstName' => '<string>',
'lastName' => '<string>'
],
'email' => 'jsmith@example.com',
'phone' => '<string>',
'dateOfBirth' => '2023-12-25'
]),
CURLOPT_HTTPHEADER => [
"Authorization: Bearer <token>",
"Content-Type: application/json"
],
]);

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

curl_close($curl);

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

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

func main() {

url := "https://api.portalhq.io/api/v3/clients/me/integrations/meld/customers"

payload := strings.NewReader("{\n \"name\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\"\n}")

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

req.Header.Add("Authorization", "Bearer <token>")
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))

}
HttpResponse<String> response = Unirest.post("https://api.portalhq.io/api/v3/clients/me/integrations/meld/customers")
.header("Authorization", "Bearer <token>")
.header("Content-Type", "application/json")
.body("{\n \"name\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://api.portalhq.io/api/v3/clients/me/integrations/meld/customers")

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

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"name\": {\n \"firstName\": \"<string>\",\n \"lastName\": \"<string>\"\n },\n \"email\": \"jsmith@example.com\",\n \"phone\": \"<string>\",\n \"dateOfBirth\": \"2023-12-25\"\n}"

response = http.request(request)
puts response.read_body
{
  "data": {
    "id": "<string>",
    "accountId": "<string>",
    "externalId": "<string>",
    "name": {
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "email": "<string>",
    "phone": "<string>",
    "dateOfBirth": "<string>",
    "addresses": [
      {
        "id": "<string>",
        "customerId": "<string>",
        "addressDetails": {
          "lineOne": "<string>",
          "lineTwo": "<string>",
          "city": "<string>",
          "region": "<string>",
          "postalCode": "<string>",
          "country": "<string>"
        }
      }
    ],
    "serviceProviders": {}
  }
}
{
"error": "<string>"
}
{
"error": "<string>"
}
{
"error": "<string>",
"details": {
"meldCustomerId": "<string>"
}
}

Authorizations

Authorization
string
header
required

Client API Key or Client Session Token (CST). Pass as a Bearer token in the Authorization header.

Body

application/json

All fields are optional.

name
object
email
string<email>
phone
string

E.164-formatted phone number.

dateOfBirth
string<date>

ISO-8601 calendar date (YYYY-MM-DD).

type
enum<string>
Available options:
INDIVIDUAL,
BUSINESS

Response

Meld customer created successfully

data
object