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": "c00b9754-a3a0-4596-b6dd-ceb160c79c64",
"CustomerId": "3281d567-af4a-45d7-8fe1-f4df2cff99f1",
"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": "c00b9754-a3a0-4596-b6dd-ceb160c79c64",
"CustomerId": "3281d567-af4a-45d7-8fe1-f4df2cff99f1",
"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": "c914af41-7567-43d9-91a5-b205c8d66be8",
"CustomerId": "15b951c9-001e-4c68-8eab-fca9fc389d85",
"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": "c914af41-7567-43d9-91a5-b205c8d66be8",
"CustomerId": "15b951c9-001e-4c68-8eab-fca9fc389d85",
"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": "0b565b26-ab76-46cd-8b5f-05192d6e5809",
"CustomerId": "4e1ca2ff-99ed-4fcf-8694-84bef562e1c8",
"ExtensionTypeId": 4,
"ExtensionType": "sample string 5",
"ExtensionTypeFeature": "sample string 6",
"Version": 7
},
{
"Value": "sample string 1",
"Id": "0b565b26-ab76-46cd-8b5f-05192d6e5809",
"CustomerId": "4e1ca2ff-99ed-4fcf-8694-84bef562e1c8",
"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-10-06T01:55:34.3599868+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": "a76fd824-f29e-42d1-96f7-cac347afa503",
"CustomerId": "ac01731f-3437-4a2a-89b2-e2cb1f94e5b4",
"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": "a76fd824-f29e-42d1-96f7-cac347afa503",
"CustomerId": "ac01731f-3437-4a2a-89b2-e2cb1f94e5b4",
"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": "6cb96826-1e05-4d9c-927c-80aea91f3273",
"CustomerId": "a1af0955-b28a-4c55-a9bf-12a4afa3061c",
"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": "6cb96826-1e05-4d9c-927c-80aea91f3273",
"CustomerId": "a1af0955-b28a-4c55-a9bf-12a4afa3061c",
"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": "5b9812dc-a044-41ca-8bd8-c1eb1bb0e56b",
"CustomerId": "ac677b4f-0fa3-4bd4-8d9e-f45b802ea0bb",
"ExtensionTypeId": 4,
"ExtensionType": "sample string 5",
"ExtensionTypeFeature": "sample string 6",
"Version": 7
},
{
"Value": "sample string 1",
"Id": "5b9812dc-a044-41ca-8bd8-c1eb1bb0e56b",
"CustomerId": "ac677b4f-0fa3-4bd4-8d9e-f45b802ea0bb",
"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-10-06T01:55:34.3756117+00:00",
"UpdatedBy": "sample string 11",
"DateUpdatedUtc": "2026-10-06T01:55:34.3756117+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-10-06T01:55:34.3756117+00:00",
"UpdatedBy": "sample string 11",
"DateUpdatedUtc": "2026-10-06T01:55:34.3756117+00:00",
"Href": "sample string 13",
"PreviewHref": "sample string 14"
}
],
"MergedCustomers": [
"227a3c9d-5d66-44ed-bd53-63487f32fdb6",
"8f37e3ff-833d-4285-bd02-e2ed551084a3"
],
"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": "55e0c835-9869-408e-a6d0-f8875aa7d600",
"CustomerTypeId": 10,
"CustomerType": "sample string 11",
"DateOfBirth": "2026-10-06T01:55:34.3756117+00:00",
"PricingGroupId": 13,
"Disabled": true,
"DoNotContact": true,
"Version": 16,
"MergedIntoCustomerId": "aca89001-9545-4402-ae20-e249aecfc005",
"LastModifiedDateUtc": "2026-10-06T01:55:34.3756117+00:00"
}