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
CustomerFullPost| Name | 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": "7cab4ead-eb65-4baa-982d-70a973621066",
"CustomerId": "03144c89-dafc-486b-ad36-c3d42ba1bea1",
"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": "7cab4ead-eb65-4baa-982d-70a973621066",
"CustomerId": "03144c89-dafc-486b-ad36-c3d42ba1bea1",
"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": "ad44c7a1-72f0-4464-8dfe-1831c192aec1",
"CustomerId": "3556fe5e-8741-4322-a3e5-24d16b3b9b56",
"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": "ad44c7a1-72f0-4464-8dfe-1831c192aec1",
"CustomerId": "3556fe5e-8741-4322-a3e5-24d16b3b9b56",
"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": "93e9df24-7546-477c-9d55-d555aa96e92f",
"CustomerId": "8e4f4f04-9666-44e6-a705-cd0e20ecc88f",
"ExtensionTypeId": 4,
"ExtensionType": "sample string 5",
"ExtensionTypeFeature": "sample string 6",
"Version": 7
},
{
"Value": "sample string 1",
"Id": "93e9df24-7546-477c-9d55-d555aa96e92f",
"CustomerId": "8e4f4f04-9666-44e6-a705-cd0e20ecc88f",
"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-12-08T06:29:20.3192493+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
CustomerFullReturn| Name | 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": "427a2f74-009c-4276-8685-85221d866f27",
"CustomerId": "fc5784ea-c10b-4a4a-a47b-d5e38bfc7315",
"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": "427a2f74-009c-4276-8685-85221d866f27",
"CustomerId": "fc5784ea-c10b-4a4a-a47b-d5e38bfc7315",
"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": "18b769ea-e802-4448-9423-fa37e498d030",
"CustomerId": "ee572915-08c0-407d-8792-2bb4f3e960b1",
"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": "18b769ea-e802-4448-9423-fa37e498d030",
"CustomerId": "ee572915-08c0-407d-8792-2bb4f3e960b1",
"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": "f503316b-1da1-4513-b114-dd67d04d6224",
"CustomerId": "7cc97adc-976d-43ce-827e-426ad4458c2b",
"ExtensionTypeId": 4,
"ExtensionType": "sample string 5",
"ExtensionTypeFeature": "sample string 6",
"Version": 7
},
{
"Value": "sample string 1",
"Id": "f503316b-1da1-4513-b114-dd67d04d6224",
"CustomerId": "7cc97adc-976d-43ce-827e-426ad4458c2b",
"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-12-08T06:29:20.3192493+00:00",
"UpdatedBy": "sample string 11",
"DateUpdatedUtc": "2025-12-08T06:29:20.3192493+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-12-08T06:29:20.3192493+00:00",
"UpdatedBy": "sample string 11",
"DateUpdatedUtc": "2025-12-08T06:29:20.3192493+00:00",
"Href": "sample string 13",
"PreviewHref": "sample string 14"
}
],
"MergedCustomers": [
"78a12f08-a2dc-44a3-b65f-e6a8b72944c5",
"5fe4a87a-4ae2-4f20-9ecc-fad752afeca8"
],
"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": "2950e143-a339-4517-9ef5-0eb6820d92f3",
"CustomerTypeId": 10,
"CustomerType": "sample string 11",
"DateOfBirth": "2025-12-08T06:29:20.3192493+00:00",
"PricingGroupId": 13,
"Disabled": true,
"DoNotContact": true,
"Version": 16,
"MergedIntoCustomerId": "a5ecef0d-ccdd-4324-8253-5273625bec3b",
"LastModifiedDateUtc": "2025-12-08T06:29:20.3192493+00:00"
}