POST v1/Companies({CompanyId})/CustomerFull

This call creates a Customer in Cova will all their attributes

Information:

Base URL:

https://api.covasoft.net/crm

Request Information

URI Parameters

NameDescriptionTypeAdditional information
CompanyId

Company Id from your onboarding package

integer

Required

Body Parameters

The Customer attributes for Customer Creation

CustomerFullPost
NameDescriptionTypeAdditional information
Addresses

Collection of Address

None.

ContactMethods

Collection of ContactMethod

None.

CustomerExtensions

Collection of CustomerExtension

None.

CustomerTypeId

integer

None.

Title

string

None.

PrimaryName

string

None.

AlternateName

string

None.

MiddleName

string

None.

FamilyName

string

None.

ReferralSource

Object

None.

DateOfBirth

date

None.

PricingGroupId

Object

None.

Notes

string

None.

UniqueIdentifier

string

None.

Disabled

boolean

None.

DoNotContact

boolean

None.

Request Formats

application/json, text/json

Sample:
{
  "Addresses": [
    {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "StateName": "sample string 4",
      "CountryName": "sample string 5",
      "Zip": 1,
      "Id": "a5aa9631-e701-4431-858d-9e8d8a9d25f7",
      "CustomerId": "4666aecf-5cb9-48cf-a902-f5c95844df02",
      "AddressTypeId": 8,
      "AddressType": "sample string 9",
      "Default": true,
      "DoNotContact": true,
      "CountryCode": "sample string 12",
      "Country": "sample string 13",
      "Locality": "sample string 14",
      "StateCode": "sample string 15",
      "State": "sample string 16",
      "PostalCode": "sample string 17",
      "PostOfficeBoxNumber": "sample string 18",
      "StreetAddress1": "sample string 19",
      "Notes": "sample string 20",
      "StreetAddress2": "sample string 21",
      "Version": 22,
      "AttentionTo": "sample string 23",
      "Phone": "sample string 24",
      "Email": "sample string 25"
    },
    {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "StateName": "sample string 4",
      "CountryName": "sample string 5",
      "Zip": 1,
      "Id": "a5aa9631-e701-4431-858d-9e8d8a9d25f7",
      "CustomerId": "4666aecf-5cb9-48cf-a902-f5c95844df02",
      "AddressTypeId": 8,
      "AddressType": "sample string 9",
      "Default": true,
      "DoNotContact": true,
      "CountryCode": "sample string 12",
      "Country": "sample string 13",
      "Locality": "sample string 14",
      "StateCode": "sample string 15",
      "State": "sample string 16",
      "PostalCode": "sample string 17",
      "PostOfficeBoxNumber": "sample string 18",
      "StreetAddress1": "sample string 19",
      "Notes": "sample string 20",
      "StreetAddress2": "sample string 21",
      "Version": 22,
      "AttentionTo": "sample string 23",
      "Phone": "sample string 24",
      "Email": "sample string 25"
    }
  ],
  "ContactMethods": [
    {
      "Value": "sample string 1",
      "Id": "04f707c9-8fbf-4614-b76d-f359b3b14711",
      "CustomerId": "108e3263-5c58-4031-bdde-22384ae94c7c",
      "ContactMethodCategoryId": 4,
      "ContactMethodCategory": "sample string 5",
      "ContactMethodTypeId": 6,
      "ContactMethodType": "sample string 7",
      "DoNotContact": true,
      "Default": true,
      "Notes": "sample string 10",
      "Version": 11
    },
    {
      "Value": "sample string 1",
      "Id": "04f707c9-8fbf-4614-b76d-f359b3b14711",
      "CustomerId": "108e3263-5c58-4031-bdde-22384ae94c7c",
      "ContactMethodCategoryId": 4,
      "ContactMethodCategory": "sample string 5",
      "ContactMethodTypeId": 6,
      "ContactMethodType": "sample string 7",
      "DoNotContact": true,
      "Default": true,
      "Notes": "sample string 10",
      "Version": 11
    }
  ],
  "CustomerExtensions": [
    {
      "Value": "sample string 1",
      "Id": "e5bad509-e2c8-4a1b-a3e5-2fbff93e7d96",
      "CustomerId": "88441974-6cf9-4bec-b2f2-af1733b2dfd9",
      "ExtensionTypeId": 4,
      "ExtensionType": "sample string 5",
      "ExtensionTypeFeature": "sample string 6",
      "Version": 7
    },
    {
      "Value": "sample string 1",
      "Id": "e5bad509-e2c8-4a1b-a3e5-2fbff93e7d96",
      "CustomerId": "88441974-6cf9-4bec-b2f2-af1733b2dfd9",
      "ExtensionTypeId": 4,
      "ExtensionType": "sample string 5",
      "ExtensionTypeFeature": "sample string 6",
      "Version": 7
    }
  ],
  "CustomerTypeId": 1,
  "Title": "sample string 2",
  "PrimaryName": "sample string 3",
  "AlternateName": "sample string 4",
  "MiddleName": "sample string 5",
  "FamilyName": "sample string 6",
  "ReferralSource": {},
  "DateOfBirth": "2024-11-07T08:38:47.7772709+00:00",
  "PricingGroupId": {},
  "Notes": "sample string 10",
  "UniqueIdentifier": "sample string 11",
  "Disabled": true,
  "DoNotContact": true
}

Response Information

Resource Description

Returns Customer Posted in Cova will all their attributes

CustomerFullReturn
NameDescriptionTypeAdditional information
Addresses

Collection of Address

None.

ContactMethods

Collection of ContactMethod

None.

CustomerExtensions

Collection of CustomerExtension

None.

RelatedCustomers

Collection of Object

None.

MemberOf

Collection of Object

None.

Documents

Collection of Object

None.

MergedCustomers

Collection of Object

None.

PrimaryName

string

None.

Title

string

None.

AlternateName

string

None.

MiddleName

string

None.

FamilyName

string

None.

ReferralSource

string

None.

Notes

string

None.

UniqueIdentifier

string

None.

Id

globally unique identifier

None.

CustomerTypeId

integer

None.

CustomerType

string

None.

DateOfBirth

date

None.

PricingGroupId

integer

None.

Disabled

boolean

None.

DoNotContact

boolean

None.

Version

integer

None.

MergedIntoCustomerId

Object

None.

LastModifiedDateUtc

date

None.

Response Formats

application/json, text/json

Sample:
{
  "Addresses": [
    {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "StateName": "sample string 4",
      "CountryName": "sample string 5",
      "Zip": 1,
      "Id": "77d66053-f559-443d-9b10-0ce5de1e3458",
      "CustomerId": "91dcedea-34bf-480e-847f-0d67b0e3138e",
      "AddressTypeId": 8,
      "AddressType": "sample string 9",
      "Default": true,
      "DoNotContact": true,
      "CountryCode": "sample string 12",
      "Country": "sample string 13",
      "Locality": "sample string 14",
      "StateCode": "sample string 15",
      "State": "sample string 16",
      "PostalCode": "sample string 17",
      "PostOfficeBoxNumber": "sample string 18",
      "StreetAddress1": "sample string 19",
      "Notes": "sample string 20",
      "StreetAddress2": "sample string 21",
      "Version": 22,
      "AttentionTo": "sample string 23",
      "Phone": "sample string 24",
      "Email": "sample string 25"
    },
    {
      "AddressLine1": "sample string 1",
      "AddressLine2": "sample string 2",
      "City": "sample string 3",
      "StateName": "sample string 4",
      "CountryName": "sample string 5",
      "Zip": 1,
      "Id": "77d66053-f559-443d-9b10-0ce5de1e3458",
      "CustomerId": "91dcedea-34bf-480e-847f-0d67b0e3138e",
      "AddressTypeId": 8,
      "AddressType": "sample string 9",
      "Default": true,
      "DoNotContact": true,
      "CountryCode": "sample string 12",
      "Country": "sample string 13",
      "Locality": "sample string 14",
      "StateCode": "sample string 15",
      "State": "sample string 16",
      "PostalCode": "sample string 17",
      "PostOfficeBoxNumber": "sample string 18",
      "StreetAddress1": "sample string 19",
      "Notes": "sample string 20",
      "StreetAddress2": "sample string 21",
      "Version": 22,
      "AttentionTo": "sample string 23",
      "Phone": "sample string 24",
      "Email": "sample string 25"
    }
  ],
  "ContactMethods": [
    {
      "Value": "sample string 1",
      "Id": "078c7455-7c5c-4fff-a4b8-af5c4ca88699",
      "CustomerId": "d7a0c454-d75f-4e81-818f-a5cfc012d8eb",
      "ContactMethodCategoryId": 4,
      "ContactMethodCategory": "sample string 5",
      "ContactMethodTypeId": 6,
      "ContactMethodType": "sample string 7",
      "DoNotContact": true,
      "Default": true,
      "Notes": "sample string 10",
      "Version": 11
    },
    {
      "Value": "sample string 1",
      "Id": "078c7455-7c5c-4fff-a4b8-af5c4ca88699",
      "CustomerId": "d7a0c454-d75f-4e81-818f-a5cfc012d8eb",
      "ContactMethodCategoryId": 4,
      "ContactMethodCategory": "sample string 5",
      "ContactMethodTypeId": 6,
      "ContactMethodType": "sample string 7",
      "DoNotContact": true,
      "Default": true,
      "Notes": "sample string 10",
      "Version": 11
    }
  ],
  "CustomerExtensions": [
    {
      "Value": "sample string 1",
      "Id": "4ddc06f1-7929-43ec-823a-2e2f69152590",
      "CustomerId": "2ada48ae-2692-44f4-8d0f-16ee67fd2c2c",
      "ExtensionTypeId": 4,
      "ExtensionType": "sample string 5",
      "ExtensionTypeFeature": "sample string 6",
      "Version": 7
    },
    {
      "Value": "sample string 1",
      "Id": "4ddc06f1-7929-43ec-823a-2e2f69152590",
      "CustomerId": "2ada48ae-2692-44f4-8d0f-16ee67fd2c2c",
      "ExtensionTypeId": 4,
      "ExtensionType": "sample string 5",
      "ExtensionTypeFeature": "sample string 6",
      "Version": 7
    }
  ],
  "RelatedCustomers": [
    {},
    {}
  ],
  "MemberOf": [
    {},
    {}
  ],
  "Documents": [
    {},
    {}
  ],
  "MergedCustomers": [
    {},
    {}
  ],
  "PrimaryName": "sample string 1",
  "Title": "sample string 2",
  "AlternateName": "sample string 3",
  "MiddleName": "sample string 4",
  "FamilyName": "sample string 5",
  "ReferralSource": "sample string 6",
  "Notes": "sample string 7",
  "UniqueIdentifier": "sample string 8",
  "Id": "0390bfe9-ed5f-4d93-a590-402e1303433e",
  "CustomerTypeId": 10,
  "CustomerType": "sample string 11",
  "DateOfBirth": "2024-11-07T08:38:47.7928976+00:00",
  "PricingGroupId": 13,
  "Disabled": true,
  "DoNotContact": true,
  "Version": 16,
  "MergedIntoCustomerId": {},
  "LastModifiedDateUtc": "2024-11-07T08:38:47.7928976+00:00"
}