POST v1/Companies({CompanyId})/CustomerFull
This call creates a Customer in Cova will all their attributes
Information:
Base URL:
https://api.covasoft.net/crm
To minimize customer duplication, always Search for potential matches prior to creating new customer records.
Request Information
URI Parameters
Name | Description | Type | Additional information |
---|---|---|---|
CompanyId |
Company Id from your onboarding package |
integer |
Required |
Body Parameters
The Customer attributes for Customer Creation
CustomerFullPostName | Description | Type | Additional 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": "1382b39a-8580-4877-9f4e-58b17c535eea", "CustomerId": "f942bf44-8ab1-4948-9177-24f91837b2a8", "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": "1382b39a-8580-4877-9f4e-58b17c535eea", "CustomerId": "f942bf44-8ab1-4948-9177-24f91837b2a8", "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": "7ea22743-ddc6-40e3-b112-9fcb389c2296", "CustomerId": "8b5a121c-e4b8-47d8-9315-9b3f08f98084", "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": "7ea22743-ddc6-40e3-b112-9fcb389c2296", "CustomerId": "8b5a121c-e4b8-47d8-9315-9b3f08f98084", "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": "1f463da3-adee-4095-a8a0-9fa070b27ddb", "CustomerId": "c74629fa-2ea9-4d8f-932d-ecd1944ff377", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "1f463da3-adee-4095-a8a0-9fa070b27ddb", "CustomerId": "c74629fa-2ea9-4d8f-932d-ecd1944ff377", "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": "2025-04-26T05:32:42.6371775+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
CustomerFullReturnName | Description | Type | Additional 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": "577fefe3-bcd5-4092-9fcf-3b471d4edebb", "CustomerId": "3ab3a2b5-2b57-4b4a-81d7-b11b99cf1e4b", "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": "577fefe3-bcd5-4092-9fcf-3b471d4edebb", "CustomerId": "3ab3a2b5-2b57-4b4a-81d7-b11b99cf1e4b", "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": "8104e9aa-7e1c-46f2-a320-f65e768d08a0", "CustomerId": "bb43d78c-2229-41ca-9a21-b903c42c1cd1", "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": "8104e9aa-7e1c-46f2-a320-f65e768d08a0", "CustomerId": "bb43d78c-2229-41ca-9a21-b903c42c1cd1", "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": "dbafc0a2-20cf-4f30-84a9-9e38899d8ce3", "CustomerId": "89283d63-628a-4a36-82fd-98fdeae0a67f", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "dbafc0a2-20cf-4f30-84a9-9e38899d8ce3", "CustomerId": "89283d63-628a-4a36-82fd-98fdeae0a67f", "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": "cea71997-4b4f-4e73-9a0a-32e6fa246ad1", "CustomerTypeId": 10, "CustomerType": "sample string 11", "DateOfBirth": "2025-04-26T05:32:42.7153039+00:00", "PricingGroupId": 13, "Disabled": true, "DoNotContact": true, "Version": 16, "MergedIntoCustomerId": {}, "LastModifiedDateUtc": "2025-04-26T05:32:42.7153039+00:00" }