Create Customer | propelone

curl -X POST https://https//https/crm/customers \
     -H "{{tenant_key_name}}: {{tenant_key_value1}}|{{tenant_key_value2}}" \
     -H "Content-Type: multipart/form-data" \
     -F status="string" \
     -F last_name="string" \
     -F first_name="string" \
     -F do_not_call="string" \
     -F do_not_text="string" \
     -F credit_limit="string" \
     -F display_name="string" \
     -F do_not_email="string" \
     -F credit_status="string" \
     -F customer_type="string" \
     -F priority_level="string" \
     -F marketing_opt_out="string" \
     -F preferred_language="string" \
     -F customer_portal_access="string"

{
  "data": [
    {
      "id": "87c0b256-d6c4-4a74-bad2-8a829f225813",
      "type": "customers",
      "attributes": {
        "status": "active",
        "last_name": "Doe",
        "first_name": "John",
        "do_not_call": false,
        "do_not_text": false,
        "credit_limit": "5000.00",
        "display_name": "John Doe",
        "do_not_email": false,
        "credit_status": "good",
        "customer_type": "residential",
        "priority_level": "standard",
        "marketing_opt_out": false,
        "preferred_language": "en",
        "customer_portal_access": true
      },
      "relationships": {
        "contacts": [],
        "locations": [],
        "created_by": {
          "user": [
            {
              "id": "28c800fb-76fc-4f1d-9458-4b886ad8936e",
              "type": "users",
              "attributes": {
                "email": "admin@propelhub.com",
                "last_name": "Admin",
                "first_name": "Propel"
              }
            }
          ],
          "created_at": "2025-09-16T19:33:15.000000Z"
        },
        "updated_by": {
          "user": [
            {
              "id": "28c800fb-76fc-4f1d-9458-4b886ad8936e",
              "type": "users",
              "attributes": {
                "email": "admin@propelhub.com",
                "last_name": "Admin",
                "first_name": "Propel"
              }
            }
          ],
          "updated_at": "2025-09-16T19:33:15.000000Z"
        }
      }
    }
  ]
}

Request

This endpoint expects a multipart form.

statusstringRequired

Optional: Status (prospect, active, inactive, suspended) - defaults to prospect

last_namestringRequired

Required: Last name (for residential customers)

first_namestringRequired

Required: First name (for residential customers)

do_not_callstringRequired

Optional: Do not call flag (true, false) - defaults to false

do_not_textstringRequired

Optional: Do not text flag (true, false) - defaults to false

credit_limitstringRequired

Optional: Credit limit amount

display_namestringRequired

Optional: Display name override

do_not_emailstringRequired

Optional: Do not email flag (true, false) - defaults to false

credit_statusstringRequired

Optional: Credit status (excellent, good, fair, poor) - defaults to good

customer_typestringRequired

Required: Customer type (residential, commercial, industrial, government)

priority_levelstringRequired

Optional: Priority level (standard, preferred, vip) - defaults to standard

marketing_opt_outstringRequired

Optional: Marketing opt out flag (true, false) - defaults to false

preferred_languagestringRequired

Optional: Preferred language (en, es, fr) - defaults to en

customer_portal_accessstringRequired

Optional: Customer portal access (true, false) - defaults to true

Response headers

Hoststring

X-Powered-Bystring

Cache-Controlstring

Response

datalist of objects

Errors

422

Unprocessable Entity Error

Headers

Request

Response headers

Response

Errors