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",
  "type": "INDIVIDUAL"
}
'
{
  "data": {
    "id": "<string>",
    "accountId": "<string>",
    "externalId": "<string>",
    "name": {
      "firstName": "<string>",
      "lastName": "<string>"
    },
    "email": "<string>",
    "phone": "<string>",
    "dateOfBirth": "<string>",
    "type": "INDIVIDUAL",
    "status": "ACTIVE",
    "addresses": [
      {
        "id": "<string>",
        "customerId": "<string>",
        "type": "BILLING",
        "status": "ACTIVE",
        "addressDetails": {
          "lineOne": "<string>",
          "lineTwo": "<string>",
          "city": "<string>",
          "region": "<string>",
          "postalCode": "<string>",
          "country": "<string>"
        }
      }
    ],
    "serviceProviders": {}
  }
}

Documentation Index

Fetch the complete documentation index at: https://docs.portalhq.io/llms.txt

Use this file to discover all available pages before exploring further.

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