Skip to content

Create customer profile

POST/customer360/profiles

Creates a new unified customer profile and immediately triggers a health score calculation. Provide at minimum a display_name. External IDs allow the profile to be cross-referenced with records from other systems (e.g. WHMCS, Stripe, HubSpot).

Request

Request body

Content type application/json (required).

FieldTypeRequiredDescription
display_namestringYes

Full display name of the customer (person or organisation).

Max length: 180

primary_emailstring (email), nullableNo

Primary contact email address for this profile.

Max length: 180

primary_phonestring, nullableNo

Primary phone number in international format.

Max length: 60

external_ids_jsonstring, nullableNo

JSON object mapping system name keys to external record IDs. Used to correlate this profile with records from other platforms (e.g. {"whmcs_client": 105, "stripe_customer": "cus_abc"}).

attributes_jsonstring, nullableNo

JSON object of arbitrary customer attributes used for segmentation (e.g. {"tier": "enterprise", "industry": "fintech"}).

Example

{
  "display_name": "Kwame Mensah",
  "primary_email": "kwame.mensah@example.test",
  "primary_phone": "+233201234567",
  "external_ids_json": "{\"whmcs_client\":105,\"stripe_customer\":\"cus_abc123\"}",
  "attributes_json": "{\"tier\":\"enterprise\",\"industry\":\"fintech\"}"
}

Responses

302 Redirect to profiles list after creation

422 Validation error — display_name is required

Content type application/json, any.

Example

{
  "errors": {
    "display_name": [
      "The display name field is required."
    ]
  }
}

Example request

curl -X POST "https://{tenant}.faciotech.net/api/v1/customer360/profiles" \
  -H "Accept: application/json" \
  -H "Content-Type: application/json" \
  -d '{"display_name": "Kwame Mensah", "primary_email": "kwame.mensah@example.test", "primary_phone": "+233201234567", "external_ids_json": "{\"whmcs_client\":105,\"stripe_customer\":\"cus_abc123\"}", "attributes_json": "{\"tier\":\"enterprise\",\"industry\":\"fintech\"}"}'
Loading