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": "dd8fba9e-c686-4eaa-836e-8a100314ef6b",
"CustomerId": "f8a8b2af-b57c-4238-a698-8ac8b7242e93",
"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": "dd8fba9e-c686-4eaa-836e-8a100314ef6b",
"CustomerId": "f8a8b2af-b57c-4238-a698-8ac8b7242e93",
"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": "53805557-af03-4dae-b75f-23b451f5c9db",
"CustomerId": "33174b3a-56a0-4b07-a214-0a5a32c701ee",
"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": "53805557-af03-4dae-b75f-23b451f5c9db",
"CustomerId": "33174b3a-56a0-4b07-a214-0a5a32c701ee",
"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": "2714ba8b-d36d-488b-9941-e6eb0ed3c48a",
"CustomerId": "92d8fe37-b758-4bd2-8e7f-fc5aaa65452f",
"ExtensionTypeId": 4,
"ExtensionType": "sample string 5",
"ExtensionTypeFeature": "sample string 6",
"Version": 7
},
{
"Value": "sample string 1",
"Id": "2714ba8b-d36d-488b-9941-e6eb0ed3c48a",
"CustomerId": "92d8fe37-b758-4bd2-8e7f-fc5aaa65452f",
"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": "2026-04-11T08:46:55.4276945+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": "7f6386aa-901a-44ed-8516-00e811724a92",
"CustomerId": "02cc8696-a9d3-40e2-be5e-459f7cede536",
"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": "7f6386aa-901a-44ed-8516-00e811724a92",
"CustomerId": "02cc8696-a9d3-40e2-be5e-459f7cede536",
"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": "3e781410-f60e-462c-935f-6f1b46708a48",
"CustomerId": "de5fa7c7-503a-4c3f-98e4-10412e69d99e",
"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": "3e781410-f60e-462c-935f-6f1b46708a48",
"CustomerId": "de5fa7c7-503a-4c3f-98e4-10412e69d99e",
"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": "ecb8942d-35a7-499d-bb79-2ecb8c69ecad",
"CustomerId": "025f435e-13fa-4d2f-97f5-b97b0a8e0ff5",
"ExtensionTypeId": 4,
"ExtensionType": "sample string 5",
"ExtensionTypeFeature": "sample string 6",
"Version": 7
},
{
"Value": "sample string 1",
"Id": "ecb8942d-35a7-499d-bb79-2ecb8c69ecad",
"CustomerId": "025f435e-13fa-4d2f-97f5-b97b0a8e0ff5",
"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": "2026-04-11T08:46:55.4276945+00:00",
"UpdatedBy": "sample string 11",
"DateUpdatedUtc": "2026-04-11T08:46:55.4276945+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": "2026-04-11T08:46:55.4276945+00:00",
"UpdatedBy": "sample string 11",
"DateUpdatedUtc": "2026-04-11T08:46:55.4276945+00:00",
"Href": "sample string 13",
"PreviewHref": "sample string 14"
}
],
"MergedCustomers": [
"37b39fb1-c14b-4f78-89ce-8d11d4051779",
"131db952-cc66-4798-b509-69779f9f991e"
],
"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": "6e3331cd-9c27-4e6a-8e3e-fca549c34bd2",
"CustomerTypeId": 10,
"CustomerType": "sample string 11",
"DateOfBirth": "2026-04-11T08:46:55.4276945+00:00",
"PricingGroupId": 13,
"Disabled": true,
"DoNotContact": true,
"Version": 16,
"MergedIntoCustomerId": "0d8be265-ebe8-4f01-8e6a-4cb118c01eea",
"LastModifiedDateUtc": "2026-04-11T08:46:55.4276945+00:00"
}