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 | string |
None. |
|
DateOfBirth | date |
None. |
|
PricingGroupId | integer |
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": "c85e5c91-5344-4c41-9321-d5d5aef883af", "CustomerId": "21cb4457-cec9-4642-a8a5-940bf34d4680", "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": "c85e5c91-5344-4c41-9321-d5d5aef883af", "CustomerId": "21cb4457-cec9-4642-a8a5-940bf34d4680", "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": "e75cd194-47e2-4651-bee2-3bac2adb9916", "CustomerId": "ee3ecd3f-e74f-407a-8d55-783fff26ff80", "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": "e75cd194-47e2-4651-bee2-3bac2adb9916", "CustomerId": "ee3ecd3f-e74f-407a-8d55-783fff26ff80", "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": "f829ae41-6510-4975-b066-44cbfb2e71ff", "CustomerId": "a7cc8f0c-902e-4df2-adfc-e24646d71f0d", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "f829ae41-6510-4975-b066-44cbfb2e71ff", "CustomerId": "a7cc8f0c-902e-4df2-adfc-e24646d71f0d", "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": "sample string 7", "DateOfBirth": "2025-07-25T13:59:49.9857583+00:00", "PricingGroupId": 9, "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 RelatedCustomer |
None. |
|
MemberOf | Collection of MemberOf |
None. |
|
Documents | Collection of Document |
None. |
|
MergedCustomers | Collection of globally unique identifier |
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 | globally unique identifier |
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": "e3472691-fed2-4c49-9364-7c39c90a65d9", "CustomerId": "b678da5a-c239-46eb-84e4-93c95ae251b4", "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": "e3472691-fed2-4c49-9364-7c39c90a65d9", "CustomerId": "b678da5a-c239-46eb-84e4-93c95ae251b4", "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": "5bade79a-7965-4a7f-8148-a842420ee5fb", "CustomerId": "92f208fe-a6cc-4e3a-b5dc-cfc8273abc22", "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": "5bade79a-7965-4a7f-8148-a842420ee5fb", "CustomerId": "92f208fe-a6cc-4e3a-b5dc-cfc8273abc22", "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": "8a07c3e2-9a29-4517-9dd1-85f2895856ff", "CustomerId": "920a3c01-bc90-468b-9db4-4d801f219662", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "8a07c3e2-9a29-4517-9dd1-85f2895856ff", "CustomerId": "920a3c01-bc90-468b-9db4-4d801f219662", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 } ], "RelatedCustomers": [ { "Id": "sample string 1", "ParentCustomerId": "sample string 2" }, { "Id": "sample string 1", "ParentCustomerId": "sample string 2" } ], "MemberOf": [ { "Id": "sample string 1", "ChildCustomerId": "sample string 2" }, { "Id": "sample string 1", "ChildCustomerId": "sample string 2" } ], "Documents": [ { "Id": "sample string 1", "CustomerId": "sample string 2", "DocumentType": "sample string 3", "DocumentTypeId": 4, "DocumentClassification": "sample string 5", "DocumentClassificationId": 6, "Name": "sample string 7", "MimeType": "sample string 8", "AddedBy": "sample string 9", "DatedAddedUtc": "2025-07-25T13:59:50.0013855+00:00", "UpdatedBy": "sample string 11", "DateUpdatedUtc": "2025-07-25T13:59:50.0013855+00:00", "Href": "sample string 13", "PreviewHref": "sample string 14" }, { "Id": "sample string 1", "CustomerId": "sample string 2", "DocumentType": "sample string 3", "DocumentTypeId": 4, "DocumentClassification": "sample string 5", "DocumentClassificationId": 6, "Name": "sample string 7", "MimeType": "sample string 8", "AddedBy": "sample string 9", "DatedAddedUtc": "2025-07-25T13:59:50.0013855+00:00", "UpdatedBy": "sample string 11", "DateUpdatedUtc": "2025-07-25T13:59:50.0013855+00:00", "Href": "sample string 13", "PreviewHref": "sample string 14" } ], "MergedCustomers": [ "8f818ab8-3f69-426c-9bd8-d0d3b37fd5d2", "81af1255-08cc-43b8-9a00-18ada2038ec2" ], "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": "271d09e9-4c78-454b-884a-c9b34ad2f6f9", "CustomerTypeId": 10, "CustomerType": "sample string 11", "DateOfBirth": "2025-07-25T13:59:50.0013855+00:00", "PricingGroupId": 13, "Disabled": true, "DoNotContact": true, "Version": 16, "MergedIntoCustomerId": "ef4f0729-978b-4995-acfe-62a7a464dc66", "LastModifiedDateUtc": "2025-07-25T13:59:50.0013855+00:00" }