Skip to main content
POST
/
external
/
customer
Create customer with its tags, internal stakeholders and contacts
curl --request POST \
  --url https://api.valyx.com/external/customer \
  --header 'Content-Type: application/json' \
  --header 'X-Valyx-Signature: <x-valyx-signature>' \
  --data '
{
  "customer": {
    "isManuallyCreated": true,
    "companyId": "<string>",
    "name": "<string>",
    "alias": "<string>",
    "registeredAddress": {
      "line1": "<string>",
      "line2": "<string>",
      "state": "<string>",
      "city": "<string>",
      "country": "<string>",
      "zipCode": "<string>"
    },
    "addresses": [
      {
        "line1": "<string>",
        "line2": "<string>",
        "state": "<string>",
        "city": "<string>",
        "country": "<string>",
        "zipCode": "<string>"
      }
    ],
    "contactsData": [
      {
        "id": "<string>",
        "name": "<string>",
        "primaryPhone": "<string>",
        "primaryEmail": "<string>",
        "role": "<string>"
      }
    ],
    "ownersData": [
      {
        "id": "<string>",
        "name": "<string>",
        "primaryPhone": "<string>",
        "primaryEmail": "<string>",
        "role": "<string>",
        "isRegistered": false
      }
    ],
    "stateCode": "<string>",
    "countryCode": "IN",
    "country": "<string>",
    "primaryPhone": "<string>",
    "primaryEmail": "<string>",
    "taxIdentifiers": [
      {
        "value": "<string>",
        "type": "GSTIN"
      }
    ],
    "customerContactPerson": "<string>",
    "currency": "INR",
    "currencyId": "<string>",
    "tags": {},
    "metaData": {},
    "customerStatus": "PROSPECT",
    "upcomingCustomerStatus": "PROSPECT",
    "upcomingCustomerStatusChangeDate": "2023-12-25",
    "upcomingCustomerStatusChangeReason": "<string>",
    "upcomingCustomerStatusChangeByUserid": "<string>",
    "erpId": "<string>"
  }
}
'
{}

Headers

X-Valyx-Signature
string
required

Auth key for creating customers

Body

application/json
customer
object

Response

200 - application/json

Success

The response is of type object.