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": "80807240-4095-427a-ab8a-895e92902a7f", "CustomerId": "1c548409-3ae5-493a-8544-3f8c3fa2e0c9", "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": "80807240-4095-427a-ab8a-895e92902a7f", "CustomerId": "1c548409-3ae5-493a-8544-3f8c3fa2e0c9", "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": "bb50b15a-db46-4749-b520-1cf0e70fa26a", "CustomerId": "9d29db12-bd4d-4b1d-b756-5c6fe47c5f68", "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": "bb50b15a-db46-4749-b520-1cf0e70fa26a", "CustomerId": "9d29db12-bd4d-4b1d-b756-5c6fe47c5f68", "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": "c6e75e7e-83fc-492f-b761-1ff54d51ae15", "CustomerId": "ac179853-cde3-40e6-ac89-f9a71167430b", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "c6e75e7e-83fc-492f-b761-1ff54d51ae15", "CustomerId": "ac179853-cde3-40e6-ac89-f9a71167430b", "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-03T23:30:19.1057885+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": "a68b9f8b-6c04-45f8-8692-cc572aa90d5f", "CustomerId": "9f606e5a-8cc1-4a82-b1e8-0147d95d7f31", "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": "a68b9f8b-6c04-45f8-8692-cc572aa90d5f", "CustomerId": "9f606e5a-8cc1-4a82-b1e8-0147d95d7f31", "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": "e9c5688c-e85d-428a-b1c9-98aa970424ae", "CustomerId": "36552133-f3f3-452a-829f-42dfaece9ef0", "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": "e9c5688c-e85d-428a-b1c9-98aa970424ae", "CustomerId": "36552133-f3f3-452a-829f-42dfaece9ef0", "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": "66c8cf5f-118f-4fb9-a93a-4199dea0186f", "CustomerId": "1ceb08e5-29ad-485e-b063-2cfe11326001", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "66c8cf5f-118f-4fb9-a93a-4199dea0186f", "CustomerId": "1ceb08e5-29ad-485e-b063-2cfe11326001", "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-03T23:30:19.2151715+00:00", "UpdatedBy": "sample string 11", "DateUpdatedUtc": "2025-07-03T23:30:19.2151715+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-03T23:30:19.2151715+00:00", "UpdatedBy": "sample string 11", "DateUpdatedUtc": "2025-07-03T23:30:19.2151715+00:00", "Href": "sample string 13", "PreviewHref": "sample string 14" } ], "MergedCustomers": [ "6ac12ba9-470c-4f06-8df8-1e51256ad9bc", "0119af42-629e-489c-ac80-5c779a1bd2a4" ], "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": "cc9ffe0e-90d1-4d2b-9112-34c8b8bf19d0", "CustomerTypeId": 10, "CustomerType": "sample string 11", "DateOfBirth": "2025-07-03T23:30:19.2151715+00:00", "PricingGroupId": 13, "Disabled": true, "DoNotContact": true, "Version": 16, "MergedIntoCustomerId": "652ae042-5d63-4a4e-87c0-8f5e6aa61397", "LastModifiedDateUtc": "2025-07-03T23:30:19.2151715+00:00" }