POST http:///api/v1/partner/store/user
Parameter name | Value | Description | Additional |
---|---|---|---|
cuid | string |
The request body takes a complete ConsumerUser resource, containing the following writable properties:
{
"accepted": "boolean",
"acceptedDate": "int64",
"active": "boolean",
"address": {
"address": "string",
"addressLine2": "string",
"city": "string",
"companyId": "string",
"country": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"latitude": "number",
"longitude": "number",
"modified": "int64",
"state": "string",
"updated": "boolean",
"zipCode": "string"
},
"addresses": [
{
"address": "string",
"addressLine2": "string",
"city": "string",
"companyId": "string",
"country": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"latitude": "number",
"longitude": "number",
"modified": "int64",
"state": "string",
"updated": "boolean",
"zipCode": "string"
}
],
"companyId": "string",
"consumerType": "string",
"cpn": "string",
"created": "int64",
"deleted": "boolean",
"dlExpiration": "int64",
"dlNo": "string",
"dlPhoto": {
"active": "boolean",
"assetType": "string",
"created": "int64",
"deleted": "boolean",
"documentId": "string",
"id": "string",
"key": "string",
"modified": "int64",
"name": "string",
"type": "string",
"updated": "boolean"
},
"dlState": "string",
"dob": "int64",
"doctorFirstName": "string",
"doctorLastName": "string",
"doctorLicense": "string",
"email": "string",
"emailOptIn": "boolean",
"firstName": "string",
"id": "string",
"importId": "string",
"lastName": "string",
"lastSyncDate": "int64",
"marketingSource": "string",
"medical": "boolean",
"memberId": "string",
"memberIds": [
"string"
],
"memberStatuses": [
{
"accepted": "boolean",
"acceptedDate": "int64",
"companyId": "string",
"consumerId": "string",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"id": "string",
"lastSyncDate": "int64",
"memberId": "string",
"modified": "int64",
"reason": "string",
"shopId": "string",
"updated": "boolean"
}
],
"middleName": "string",
"modified": "int64",
"notificationType": "string",
"password": "string",
"primaryPhone": "string",
"reason": "string",
"recExpiration": "int64",
"recIssueDate": "int64",
"recNo": "string",
"recPhoto": {
"active": "boolean",
"assetType": "string",
"created": "int64",
"deleted": "boolean",
"documentId": "string",
"id": "string",
"key": "string",
"modified": "int64",
"name": "string",
"type": "string",
"updated": "boolean"
},
"rejectedDate": "int64",
"searchText": "string",
"sex": "string",
"signedContracts": [
{
"companyId": "string",
"consumerId": "string",
"contractId": "string",
"created": "int64",
"deleted": "boolean",
"dirty": "boolean",
"employeeName": "string",
"employeeSignaturePhoto": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
},
"id": "string",
"memberName": "string",
"membershipId": "string",
"modified": "int64",
"shopId": "string",
"signaturePhoto": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
},
"signedDate": "int64",
"signedDigitally": "boolean",
"updated": "boolean",
"witnessName": "string",
"witnessSignaturePhoto": {
"active": "boolean",
"assetType": "string",
"companyId": "string",
"created": "int64",
"deleted": "boolean",
"id": "string",
"key": "string",
"largeURL": "string",
"largeX2URL": "string",
"mediumURL": "string",
"modified": "int64",
"name": "string",
"origURL": "string",
"priority": "int32",
"publicURL": "string",
"secured": "boolean",
"thumbURL": "string",
"type": "string",
"updated": "boolean"
}
}
],
"source": "string",
"sourceCompanyId": "string",
"textOptIn": "boolean",
"updated": "boolean",
"verificationPhone": "string",
"verificationWebsite": "string",
"verified": "boolean",
"verifyMethod": "string"
}
Name | Type | Description | Additional |
---|---|---|---|
accepted | boolean | Optional | |
acceptedDate | int64 | Optional | |
active | boolean | Optional | |
address | object | Address | Optional |
address.address | string | Optional | |
address.addressLine2 | string | Optional | |
address.city | string | Optional | |
address.companyId | string | Optional | |
address.country | string | Optional | |
address.created | int64 | Optional | |
address.deleted | boolean | Optional | |
address.id | string | Optional | |
address.latitude | number | Optional | |
address.longitude | number | Optional | |
address.modified | int64 | Optional | |
address.state | string | Optional | |
address.updated | boolean | Optional | |
address.zipCode | string | Optional | |
addresses[] | array | Optional | |
addresses[].address | string | Optional | |
addresses[].addressLine2 | string | Optional | |
addresses[].city | string | Optional | |
addresses[].companyId | string | Optional | |
addresses[].country | string | Optional | |
addresses[].created | int64 | Optional | |
addresses[].deleted | boolean | Optional | |
addresses[].id | string | Optional | |
addresses[].latitude | number | Optional | |
addresses[].longitude | number | Optional | |
addresses[].modified | int64 | Optional | |
addresses[].state | string | Optional | |
addresses[].updated | boolean | Optional | |
addresses[].zipCode | string | Optional | |
companyId | string | Optional | |
consumerType | string |
Possible values are:
|
Optional |
cpn | string | Optional | |
created | int64 | Optional | |
deleted | boolean | Optional | |
dlExpiration | int64 | Optional | |
dlNo | string | Optional | |
dlPhoto | object | ConsumerAsset | Optional |
dlPhoto.active | boolean | Optional | |
dlPhoto.assetType | string |
Possible values are:
|
Optional |
dlPhoto.created | int64 | Optional | |
dlPhoto.deleted | boolean | Optional | |
dlPhoto.documentId | string | Optional | |
dlPhoto.id | string | Optional | |
dlPhoto.key | string | Optional | |
dlPhoto.modified | int64 | Optional | |
dlPhoto.name | string | Optional | |
dlPhoto.type | string |
Possible values are:
|
Optional |
dlPhoto.updated | boolean | Optional | |
dlState | string | Optional | |
dob | int64 | Optional | |
doctorFirstName | string | Optional | |
doctorLastName | string | Optional | |
doctorLicense | string | Optional | |
string | Optional | ||
emailOptIn | boolean | Optional | |
firstName | string | Optional | |
id | string | Optional | |
importId | string | Optional | |
lastName | string | Optional | |
lastSyncDate | int64 | Optional | |
marketingSource | string | Optional | |
medical | boolean | Optional | |
memberId | string | Optional | |
memberIds[] | array of string | Optional | |
memberStatuses[] | array | Optional | |
memberStatuses[].accepted | boolean | Optional | |
memberStatuses[].acceptedDate | int64 | Optional | |
memberStatuses[].companyId | string | Optional | |
memberStatuses[].consumerId | string | Optional | |
memberStatuses[].created | int64 | Optional | |
memberStatuses[].deleted | boolean | Optional | |
memberStatuses[].dirty | boolean | Optional | |
memberStatuses[].id | string | Optional | |
memberStatuses[].lastSyncDate | int64 | Optional | |
memberStatuses[].memberId | string | Optional | |
memberStatuses[].modified | int64 | Optional | |
memberStatuses[].reason | string | Optional | |
memberStatuses[].shopId | string | Optional | |
memberStatuses[].updated | boolean | Optional | |
middleName | string | Optional | |
modified | int64 | Optional | |
notificationType | string |
Possible values are:
|
Optional |
password | string | Optional | |
primaryPhone | string | Optional | |
reason | string | Optional | |
recExpiration | int64 | Optional | |
recIssueDate | int64 | Optional | |
recNo | string | Optional | |
recPhoto | object | ConsumerAsset | Optional |
recPhoto.active | boolean | Optional | |
recPhoto.assetType | string |
Possible values are:
|
Optional |
recPhoto.created | int64 | Optional | |
recPhoto.deleted | boolean | Optional | |
recPhoto.documentId | string | Optional | |
recPhoto.id | string | Optional | |
recPhoto.key | string | Optional | |
recPhoto.modified | int64 | Optional | |
recPhoto.name | string | Optional | |
recPhoto.type | string |
Possible values are:
|
Optional |
recPhoto.updated | boolean | Optional | |
rejectedDate | int64 | Optional | |
searchText | string | Optional | |
sex | string |
Possible values are:
|
Optional |
signedContracts[] | array | Optional | |
signedContracts[].companyId | string | Optional | |
signedContracts[].consumerId | string | Optional | |
signedContracts[].contractId | string | Optional | |
signedContracts[].created | int64 | Optional | |
signedContracts[].deleted | boolean | Optional | |
signedContracts[].dirty | boolean | Optional | |
signedContracts[].employeeName | string | Optional | |
signedContracts[].employeeSignaturePhoto | object | CompanyAsset | Optional |
signedContracts[].employeeSignaturePhoto.active | boolean | Optional | |
signedContracts[].employeeSignaturePhoto.assetType | string |
Possible values are:
|
Optional |
signedContracts[].employeeSignaturePhoto.companyId | string | Optional | |
signedContracts[].employeeSignaturePhoto.created | int64 | Optional | |
signedContracts[].employeeSignaturePhoto.deleted | boolean | Optional | |
signedContracts[].employeeSignaturePhoto.id | string | Optional | |
signedContracts[].employeeSignaturePhoto.key | string | Optional | |
signedContracts[].employeeSignaturePhoto.largeURL | string | Optional | |
signedContracts[].employeeSignaturePhoto.largeX2URL | string | Optional | |
signedContracts[].employeeSignaturePhoto.mediumURL | string | Optional | |
signedContracts[].employeeSignaturePhoto.modified | int64 | Optional | |
signedContracts[].employeeSignaturePhoto.name | string | Optional | |
signedContracts[].employeeSignaturePhoto.origURL | string | Optional | |
signedContracts[].employeeSignaturePhoto.priority | int32 | Optional | |
signedContracts[].employeeSignaturePhoto.publicURL | string | Optional | |
signedContracts[].employeeSignaturePhoto.secured | boolean | Optional | |
signedContracts[].employeeSignaturePhoto.thumbURL | string | Optional | |
signedContracts[].employeeSignaturePhoto.type | string |
Possible values are:
|
Optional |
signedContracts[].employeeSignaturePhoto.updated | boolean | Optional | |
signedContracts[].id | string | Optional | |
signedContracts[].memberName | string | Optional | |
signedContracts[].membershipId | string | Optional | |
signedContracts[].modified | int64 | Optional | |
signedContracts[].shopId | string | Optional | |
signedContracts[].signaturePhoto | object | CompanyAsset | Optional |
signedContracts[].signaturePhoto.active | boolean | Optional | |
signedContracts[].signaturePhoto.assetType | string |
Possible values are:
|
Optional |
signedContracts[].signaturePhoto.companyId | string | Optional | |
signedContracts[].signaturePhoto.created | int64 | Optional | |
signedContracts[].signaturePhoto.deleted | boolean | Optional | |
signedContracts[].signaturePhoto.id | string | Optional | |
signedContracts[].signaturePhoto.key | string | Optional | |
signedContracts[].signaturePhoto.largeURL | string | Optional | |
signedContracts[].signaturePhoto.largeX2URL | string | Optional | |
signedContracts[].signaturePhoto.mediumURL | string | Optional | |
signedContracts[].signaturePhoto.modified | int64 | Optional | |
signedContracts[].signaturePhoto.name | string | Optional | |
signedContracts[].signaturePhoto.origURL | string | Optional | |
signedContracts[].signaturePhoto.priority | int32 | Optional | |
signedContracts[].signaturePhoto.publicURL | string | Optional | |
signedContracts[].signaturePhoto.secured | boolean | Optional | |
signedContracts[].signaturePhoto.thumbURL | string | Optional | |
signedContracts[].signaturePhoto.type | string |
Possible values are:
|
Optional |
signedContracts[].signaturePhoto.updated | boolean | Optional | |
signedContracts[].signedDate | int64 | Optional | |
signedContracts[].signedDigitally | boolean | Optional | |
signedContracts[].updated | boolean | Optional | |
signedContracts[].witnessName | string | Optional | |
signedContracts[].witnessSignaturePhoto | object | CompanyAsset | Optional |
signedContracts[].witnessSignaturePhoto.active | boolean | Optional | |
signedContracts[].witnessSignaturePhoto.assetType | string |
Possible values are:
|
Optional |
signedContracts[].witnessSignaturePhoto.companyId | string | Optional | |
signedContracts[].witnessSignaturePhoto.created | int64 | Optional | |
signedContracts[].witnessSignaturePhoto.deleted | boolean | Optional | |
signedContracts[].witnessSignaturePhoto.id | string | Optional | |
signedContracts[].witnessSignaturePhoto.key | string | Optional | |
signedContracts[].witnessSignaturePhoto.largeURL | string | Optional | |
signedContracts[].witnessSignaturePhoto.largeX2URL | string | Optional | |
signedContracts[].witnessSignaturePhoto.mediumURL | string | Optional | |
signedContracts[].witnessSignaturePhoto.modified | int64 | Optional | |
signedContracts[].witnessSignaturePhoto.name | string | Optional | |
signedContracts[].witnessSignaturePhoto.origURL | string | Optional | |
signedContracts[].witnessSignaturePhoto.priority | int32 | Optional | |
signedContracts[].witnessSignaturePhoto.publicURL | string | Optional | |
signedContracts[].witnessSignaturePhoto.secured | boolean | Optional | |
signedContracts[].witnessSignaturePhoto.thumbURL | string | Optional | |
signedContracts[].witnessSignaturePhoto.type | string |
Possible values are:
|
Optional |
signedContracts[].witnessSignaturePhoto.updated | boolean | Optional | |
source | string |
Possible values are:
|
Optional |
sourceCompanyId | string | Optional | |
textOptIn | boolean | Optional | |
updated | boolean | Optional | |
verificationPhone | string | Optional | |
verificationWebsite | string | Optional | |
verified | boolean | Optional | |
verifyMethod | string |
Possible values are:
|
Optional |
The following HTTP status codes may be returned, optionally with a response resource.
Status code | Description | Resource |
---|---|---|
200 | OK successful operation |
ConsumerUser |