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": "2dc561f9-503a-4d96-bcb3-eb9d414f4526",
"CustomerId": "2e5f5269-7148-4680-84e2-f18f85c6d01a",
"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": "2dc561f9-503a-4d96-bcb3-eb9d414f4526",
"CustomerId": "2e5f5269-7148-4680-84e2-f18f85c6d01a",
"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": "cb4e25a0-d79a-4214-b81a-e6ee9b9b5ebe",
"CustomerId": "39495a4c-3185-415b-9251-d6400d78eb26",
"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": "cb4e25a0-d79a-4214-b81a-e6ee9b9b5ebe",
"CustomerId": "39495a4c-3185-415b-9251-d6400d78eb26",
"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": "9e78909a-8b17-423e-8355-c53c3f28606f",
"CustomerId": "90429b64-1801-410d-8997-92f2f564c38a",
"ExtensionTypeId": 4,
"ExtensionType": "sample string 5",
"ExtensionTypeFeature": "sample string 6",
"Version": 7
},
{
"Value": "sample string 1",
"Id": "9e78909a-8b17-423e-8355-c53c3f28606f",
"CustomerId": "90429b64-1801-410d-8997-92f2f564c38a",
"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-11T16:28:43.2360464+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": "e885c5ae-42d4-4b6a-a30d-5d0e7bca2c78",
"CustomerId": "511acffc-eb50-400a-9284-0347b158c804",
"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": "e885c5ae-42d4-4b6a-a30d-5d0e7bca2c78",
"CustomerId": "511acffc-eb50-400a-9284-0347b158c804",
"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": "89094037-36d9-4ed9-9cc4-9fa7dc1d509f",
"CustomerId": "cb505ceb-2eab-4178-a30e-6d7cf82ff49d",
"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": "89094037-36d9-4ed9-9cc4-9fa7dc1d509f",
"CustomerId": "cb505ceb-2eab-4178-a30e-6d7cf82ff49d",
"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": "9baa6d6b-c026-48f1-83ff-67e51651fb9b",
"CustomerId": "ebf88761-7f3c-448b-ba72-4edf302149a1",
"ExtensionTypeId": 4,
"ExtensionType": "sample string 5",
"ExtensionTypeFeature": "sample string 6",
"Version": 7
},
{
"Value": "sample string 1",
"Id": "9baa6d6b-c026-48f1-83ff-67e51651fb9b",
"CustomerId": "ebf88761-7f3c-448b-ba72-4edf302149a1",
"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-11T16:28:43.2672986+00:00",
"UpdatedBy": "sample string 11",
"DateUpdatedUtc": "2025-12-11T16:28:43.2672986+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-11T16:28:43.2672986+00:00",
"UpdatedBy": "sample string 11",
"DateUpdatedUtc": "2025-12-11T16:28:43.2672986+00:00",
"Href": "sample string 13",
"PreviewHref": "sample string 14"
}
],
"MergedCustomers": [
"636de7dd-0ec2-41bc-9f8f-2db15c4da48e",
"504e7e12-88b0-45e4-af59-5f4ca2b84264"
],
"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": "cfa07da0-78fc-4134-8359-4e80313f7fc5",
"CustomerTypeId": 10,
"CustomerType": "sample string 11",
"DateOfBirth": "2025-12-11T16:28:43.2672986+00:00",
"PricingGroupId": 13,
"Disabled": true,
"DoNotContact": true,
"Version": 16,
"MergedIntoCustomerId": "42b73c72-d5d6-4611-bb65-00d0083250e8",
"LastModifiedDateUtc": "2025-12-11T16:28:43.2672986+00:00"
}