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": "eae803f1-d9ec-4589-825f-b179ed889917", "CustomerId": "687ba446-5b3c-4ac1-8172-21def3eb814a", "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": "eae803f1-d9ec-4589-825f-b179ed889917", "CustomerId": "687ba446-5b3c-4ac1-8172-21def3eb814a", "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": "470e691a-d7f4-455a-90b5-9886f8619006", "CustomerId": "4fd628cc-c126-49c1-989b-0954a5b1feb0", "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": "470e691a-d7f4-455a-90b5-9886f8619006", "CustomerId": "4fd628cc-c126-49c1-989b-0954a5b1feb0", "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": "c2b2ac76-5282-45a1-b297-4c57e06c9b00", "CustomerId": "c1a93f46-c3cd-41f6-9ac3-3d36e2976061", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "c2b2ac76-5282-45a1-b297-4c57e06c9b00", "CustomerId": "c1a93f46-c3cd-41f6-9ac3-3d36e2976061", "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-03-31T10:32:59.2019637+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": "b68f7018-5ec7-4685-b0b9-04faf1c44e7f", "CustomerId": "866a9405-cdba-4a6a-bb0b-896463b763d9", "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": "b68f7018-5ec7-4685-b0b9-04faf1c44e7f", "CustomerId": "866a9405-cdba-4a6a-bb0b-896463b763d9", "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": "4e59f4e5-a7dc-482e-b0da-e410731733a4", "CustomerId": "252c7d7f-7ce0-452a-91f7-2fe06948a15d", "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": "4e59f4e5-a7dc-482e-b0da-e410731733a4", "CustomerId": "252c7d7f-7ce0-452a-91f7-2fe06948a15d", "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": "2baaac94-0a0f-4773-bc31-b31b88d17489", "CustomerId": "5df2690b-d692-414b-8150-7e90ae9a7ec4", "ExtensionTypeId": 4, "ExtensionType": "sample string 5", "ExtensionTypeFeature": "sample string 6", "Version": 7 }, { "Value": "sample string 1", "Id": "2baaac94-0a0f-4773-bc31-b31b88d17489", "CustomerId": "5df2690b-d692-414b-8150-7e90ae9a7ec4", "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": "70ecf9c6-0b5e-417f-87cb-a80d7cc28966", "CustomerTypeId": 10, "CustomerType": "sample string 11", "DateOfBirth": "2025-03-31T10:32:59.2019637+00:00", "PricingGroupId": 13, "Disabled": true, "DoNotContact": true, "Version": 16, "MergedIntoCustomerId": {}, "LastModifiedDateUtc": "2025-03-31T10:32:59.2019637+00:00" }