Update Member

Request

PUT http:///api/v1/partner/members/{memberId}

Path parameters

Parameter name Value Description Additional
memberId string Required

Request body

The request body takes a complete MembershipUpdateRequest resource, containing the following writable properties:

{
    "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"
        }
    ],
    "agreementExpired": "boolean",
    "anonymous": "boolean",
    "banPatient": "boolean",
    "careGivers": [
        "string"
    ],
    "companyId": "string",
    "consumerType": "string",
    "consumerUserId": "string",
    "contracts": [
        {
            "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"
            }
        }
    ],
    "cpn": "string",
    "created": "int64",
    "deleted": "boolean",
    "dirty": "boolean",
    "dlExpired": "boolean",
    "dob": "int64",
    "email": "string",
    "emailOptIn": "boolean",
    "emailVerified": "boolean",
    "enableLoyalty": "boolean",
    "enabledCareGiver": "boolean",
    "expStatuses": [
        "string"
    ],
    "firstName": "string",
    "id": "string",
    "identifications": [
        {
            "assets": [
                {
                    "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"
                }
            ],
            "companyId": "string",
            "created": "int64",
            "deleted": "boolean",
            "expirationDate": "int64",
            "frontPhoto": {
                "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",
            "licenseNumber": "string",
            "modified": "int64",
            "state": "string",
            "type": "string",
            "updated": "boolean",
            "verified": "boolean"
        }
    ],
    "importId": "string",
    "lastName": "string",
    "lastVisitDate": "int64",
    "lastestRecommendation": {
        "assets": [
            {
                "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"
            }
        ],
        "companyId": "string",
        "created": "int64",
        "deleted": "boolean",
        "doctor": {
            "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"
            },
            "assets": [
                {
                    "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"
                }
            ],
            "companyId": "string",
            "created": "int64",
            "degree": "string",
            "deleted": "boolean",
            "email": "string",
            "fax": "string",
            "firstName": "string",
            "id": "string",
            "importId": "string",
            "lastName": "string",
            "license": "string",
            "modified": "int64",
            "notes": [
                {
                    "created": "int64",
                    "deleted": "boolean",
                    "enableOnFleet": "boolean",
                    "id": "string",
                    "message": "string",
                    "modified": "int64",
                    "updated": "boolean",
                    "writerId": "string",
                    "writerName": "string"
                }
            ],
            "phoneNumber": "string",
            "searchText": "string",
            "state": "string",
            "updated": "boolean",
            "website": "string"
        },
        "doctorId": "string",
        "expirationDate": "int64",
        "frontPhoto": {
            "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",
        "issueDate": "int64",
        "limitExemption": "boolean",
        "modified": "int64",
        "recommendationNumber": "string",
        "state": "string",
        "temporary": "boolean",
        "updated": "boolean",
        "verified": "boolean",
        "verifyMethod": "string",
        "verifyPhoneNumber": "string",
        "verifyWebsite": "string"
    },
    "lifetimePoints": "number",
    "loyaltyPoints": "number",
    "marketingSource": "string",
    "medical": "boolean",
    "memberGroup": {
        "active": "boolean",
        "companyId": "string",
        "created": "int64",
        "defaultGroup": "boolean",
        "deleted": "boolean",
        "dirty": "boolean",
        "discount": "number",
        "discountType": "string",
        "enablePromotion": "boolean",
        "id": "string",
        "memberCount": "int32",
        "memberCountEmailOptIn": "int32",
        "memberCountTextOptIn": "int32",
        "modified": "int64",
        "name": "string",
        "promotionId": "string",
        "promotionShopMap": {
            "<key>": "string"
        },
        "shopId": "string",
        "updated": "boolean"
    },
    "memberGroupId": "string",
    "middleName": "string",
    "modified": "int64",
    "notes": [
        {
            "created": "int64",
            "deleted": "boolean",
            "enableOnFleet": "boolean",
            "id": "string",
            "message": "string",
            "modified": "int64",
            "updated": "boolean",
            "writerId": "string",
            "writerName": "string"
        }
    ],
    "preferences": [
        {
            "companyId": "string",
            "created": "int64",
            "deleted": "boolean",
            "id": "string",
            "modified": "int64",
            "name": "string",
            "updated": "boolean"
        }
    ],
    "primaryPhone": "string",
    "qbCustomerRef": [
        {
            "<key>": "string"
        }
    ],
    "recentProducts": [
        "string"
    ],
    "recommendationExpired": "boolean",
    "recommendationExpiryLeft": "int64",
    "recommendations": [
        {
            "assets": [
                {
                    "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"
                }
            ],
            "companyId": "string",
            "created": "int64",
            "deleted": "boolean",
            "doctor": {
                "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"
                },
                "assets": [
                    {
                        "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"
                    }
                ],
                "companyId": "string",
                "created": "int64",
                "degree": "string",
                "deleted": "boolean",
                "email": "string",
                "fax": "string",
                "firstName": "string",
                "id": "string",
                "importId": "string",
                "lastName": "string",
                "license": "string",
                "modified": "int64",
                "notes": [
                    {
                        "created": "int64",
                        "deleted": "boolean",
                        "enableOnFleet": "boolean",
                        "id": "string",
                        "message": "string",
                        "modified": "int64",
                        "updated": "boolean",
                        "writerId": "string",
                        "writerName": "string"
                    }
                ],
                "phoneNumber": "string",
                "searchText": "string",
                "state": "string",
                "updated": "boolean",
                "website": "string"
            },
            "doctorId": "string",
            "expirationDate": "int64",
            "frontPhoto": {
                "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",
            "issueDate": "int64",
            "limitExemption": "boolean",
            "modified": "int64",
            "recommendationNumber": "string",
            "state": "string",
            "temporary": "boolean",
            "updated": "boolean",
            "verified": "boolean",
            "verifyMethod": "string",
            "verifyPhoneNumber": "string",
            "verifyWebsite": "string"
        }
    ],
    "regionId": "string",
    "searchText": "string",
    "sex": "string",
    "shopId": "string",
    "startDate": "int64",
    "status": "string",
    "tags": [
        "string"
    ],
    "textOptIn": "boolean",
    "updated": "boolean",
    "uppercaseCity": "string"
}

Properties

Name Type Description Additional
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
agreementExpired boolean Optional
anonymous boolean Optional
banPatient boolean Optional
careGivers[] array of string Optional
companyId string Optional
consumerType string

Possible values are:

  • Other
  • AdultUse
  • MedicinalState
  • MedicinalThirdParty
 Optional
consumerUserId string Optional
contracts[] array Optional
contracts[].companyId string Optional
contracts[].consumerId string Optional
contracts[].contractId string Optional
contracts[].created int64 Optional
contracts[].deleted boolean Optional
contracts[].dirty boolean Optional
contracts[].employeeName string Optional
contracts[].employeeSignaturePhoto object CompanyAsset Optional
contracts[].employeeSignaturePhoto.active boolean Optional
contracts[].employeeSignaturePhoto.assetType string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
contracts[].employeeSignaturePhoto.companyId string Optional
contracts[].employeeSignaturePhoto.created int64 Optional
contracts[].employeeSignaturePhoto.deleted boolean Optional
contracts[].employeeSignaturePhoto.id string Optional
contracts[].employeeSignaturePhoto.key string Optional
contracts[].employeeSignaturePhoto.largeURL string Optional
contracts[].employeeSignaturePhoto.largeX2URL string Optional
contracts[].employeeSignaturePhoto.mediumURL string Optional
contracts[].employeeSignaturePhoto.modified int64 Optional
contracts[].employeeSignaturePhoto.name string Optional
contracts[].employeeSignaturePhoto.origURL string Optional
contracts[].employeeSignaturePhoto.priority int32 Optional
contracts[].employeeSignaturePhoto.publicURL string Optional
contracts[].employeeSignaturePhoto.secured boolean Optional
contracts[].employeeSignaturePhoto.thumbURL string Optional
contracts[].employeeSignaturePhoto.type string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
contracts[].employeeSignaturePhoto.updated boolean Optional
contracts[].id string Optional
contracts[].memberName string Optional
contracts[].membershipId string Optional
contracts[].modified int64 Optional
contracts[].shopId string Optional
contracts[].signaturePhoto object CompanyAsset Optional
contracts[].signaturePhoto.active boolean Optional
contracts[].signaturePhoto.assetType string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
contracts[].signaturePhoto.companyId string Optional
contracts[].signaturePhoto.created int64 Optional
contracts[].signaturePhoto.deleted boolean Optional
contracts[].signaturePhoto.id string Optional
contracts[].signaturePhoto.key string Optional
contracts[].signaturePhoto.largeURL string Optional
contracts[].signaturePhoto.largeX2URL string Optional
contracts[].signaturePhoto.mediumURL string Optional
contracts[].signaturePhoto.modified int64 Optional
contracts[].signaturePhoto.name string Optional
contracts[].signaturePhoto.origURL string Optional
contracts[].signaturePhoto.priority int32 Optional
contracts[].signaturePhoto.publicURL string Optional
contracts[].signaturePhoto.secured boolean Optional
contracts[].signaturePhoto.thumbURL string Optional
contracts[].signaturePhoto.type string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
contracts[].signaturePhoto.updated boolean Optional
contracts[].signedDate int64 Optional
contracts[].signedDigitally boolean Optional
contracts[].updated boolean Optional
contracts[].witnessName string Optional
contracts[].witnessSignaturePhoto object CompanyAsset Optional
contracts[].witnessSignaturePhoto.active boolean Optional
contracts[].witnessSignaturePhoto.assetType string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
contracts[].witnessSignaturePhoto.companyId string Optional
contracts[].witnessSignaturePhoto.created int64 Optional
contracts[].witnessSignaturePhoto.deleted boolean Optional
contracts[].witnessSignaturePhoto.id string Optional
contracts[].witnessSignaturePhoto.key string Optional
contracts[].witnessSignaturePhoto.largeURL string Optional
contracts[].witnessSignaturePhoto.largeX2URL string Optional
contracts[].witnessSignaturePhoto.mediumURL string Optional
contracts[].witnessSignaturePhoto.modified int64 Optional
contracts[].witnessSignaturePhoto.name string Optional
contracts[].witnessSignaturePhoto.origURL string Optional
contracts[].witnessSignaturePhoto.priority int32 Optional
contracts[].witnessSignaturePhoto.publicURL string Optional
contracts[].witnessSignaturePhoto.secured boolean Optional
contracts[].witnessSignaturePhoto.thumbURL string Optional
contracts[].witnessSignaturePhoto.type string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
contracts[].witnessSignaturePhoto.updated boolean Optional
cpn string Optional
created int64 Optional
deleted boolean Optional
dirty boolean Optional
dlExpired boolean Optional
dob int64 Optional
email string Optional
emailOptIn boolean Optional
emailVerified boolean Optional
enableLoyalty boolean Optional
enabledCareGiver boolean Optional
expStatuses[] array of string Optional
firstName string Optional
id string Optional
identifications[] array Optional
identifications[].assets[] array Optional
identifications[].assets[].active boolean Optional
identifications[].assets[].assetType string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
identifications[].assets[].companyId string Optional
identifications[].assets[].created int64 Optional
identifications[].assets[].deleted boolean Optional
identifications[].assets[].id string Optional
identifications[].assets[].key string Optional
identifications[].assets[].largeURL string Optional
identifications[].assets[].largeX2URL string Optional
identifications[].assets[].mediumURL string Optional
identifications[].assets[].modified int64 Optional
identifications[].assets[].name string Optional
identifications[].assets[].origURL string Optional
identifications[].assets[].priority int32 Optional
identifications[].assets[].publicURL string Optional
identifications[].assets[].secured boolean Optional
identifications[].assets[].thumbURL string Optional
identifications[].assets[].type string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
identifications[].assets[].updated boolean Optional
identifications[].companyId string Optional
identifications[].created int64 Optional
identifications[].deleted boolean Optional
identifications[].expirationDate int64 Optional
identifications[].frontPhoto object CompanyAsset Optional
identifications[].frontPhoto.active boolean Optional
identifications[].frontPhoto.assetType string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
identifications[].frontPhoto.companyId string Optional
identifications[].frontPhoto.created int64 Optional
identifications[].frontPhoto.deleted boolean Optional
identifications[].frontPhoto.id string Optional
identifications[].frontPhoto.key string Optional
identifications[].frontPhoto.largeURL string Optional
identifications[].frontPhoto.largeX2URL string Optional
identifications[].frontPhoto.mediumURL string Optional
identifications[].frontPhoto.modified int64 Optional
identifications[].frontPhoto.name string Optional
identifications[].frontPhoto.origURL string Optional
identifications[].frontPhoto.priority int32 Optional
identifications[].frontPhoto.publicURL string Optional
identifications[].frontPhoto.secured boolean Optional
identifications[].frontPhoto.thumbURL string Optional
identifications[].frontPhoto.type string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
identifications[].frontPhoto.updated boolean Optional
identifications[].id string Optional
identifications[].licenseNumber string Optional
identifications[].modified int64 Optional
identifications[].state string Optional
identifications[].type string

Possible values are:

  • Drivers
  • Passport
  • StateId
  • Other
 Optional
identifications[].updated boolean Optional
identifications[].verified boolean Optional
importId string Optional
lastName string Optional
lastVisitDate int64 Optional
lastestRecommendation object Recommendation Optional
lastestRecommendation.assets[] array Optional
lastestRecommendation.assets[].active boolean Optional
lastestRecommendation.assets[].assetType string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
lastestRecommendation.assets[].companyId string Optional
lastestRecommendation.assets[].created int64 Optional
lastestRecommendation.assets[].deleted boolean Optional
lastestRecommendation.assets[].id string Optional
lastestRecommendation.assets[].key string Optional
lastestRecommendation.assets[].largeURL string Optional
lastestRecommendation.assets[].largeX2URL string Optional
lastestRecommendation.assets[].mediumURL string Optional
lastestRecommendation.assets[].modified int64 Optional
lastestRecommendation.assets[].name string Optional
lastestRecommendation.assets[].origURL string Optional
lastestRecommendation.assets[].priority int32 Optional
lastestRecommendation.assets[].publicURL string Optional
lastestRecommendation.assets[].secured boolean Optional
lastestRecommendation.assets[].thumbURL string Optional
lastestRecommendation.assets[].type string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
lastestRecommendation.assets[].updated boolean Optional
lastestRecommendation.companyId string Optional
lastestRecommendation.created int64 Optional
lastestRecommendation.deleted boolean Optional
lastestRecommendation.doctor object Doctor Optional
lastestRecommendation.doctor.active boolean Optional
lastestRecommendation.doctor.address object Address Optional
lastestRecommendation.doctor.address.address string Optional
lastestRecommendation.doctor.address.addressLine2 string Optional
lastestRecommendation.doctor.address.city string Optional
lastestRecommendation.doctor.address.companyId string Optional
lastestRecommendation.doctor.address.country string Optional
lastestRecommendation.doctor.address.created int64 Optional
lastestRecommendation.doctor.address.deleted boolean Optional
lastestRecommendation.doctor.address.id string Optional
lastestRecommendation.doctor.address.latitude number Optional
lastestRecommendation.doctor.address.longitude number Optional
lastestRecommendation.doctor.address.modified int64 Optional
lastestRecommendation.doctor.address.state string Optional
lastestRecommendation.doctor.address.updated boolean Optional
lastestRecommendation.doctor.address.zipCode string Optional
lastestRecommendation.doctor.assets[] array Optional
lastestRecommendation.doctor.assets[].active boolean Optional
lastestRecommendation.doctor.assets[].assetType string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
lastestRecommendation.doctor.assets[].companyId string Optional
lastestRecommendation.doctor.assets[].created int64 Optional
lastestRecommendation.doctor.assets[].deleted boolean Optional
lastestRecommendation.doctor.assets[].id string Optional
lastestRecommendation.doctor.assets[].key string Optional
lastestRecommendation.doctor.assets[].largeURL string Optional
lastestRecommendation.doctor.assets[].largeX2URL string Optional
lastestRecommendation.doctor.assets[].mediumURL string Optional
lastestRecommendation.doctor.assets[].modified int64 Optional
lastestRecommendation.doctor.assets[].name string Optional
lastestRecommendation.doctor.assets[].origURL string Optional
lastestRecommendation.doctor.assets[].priority int32 Optional
lastestRecommendation.doctor.assets[].publicURL string Optional
lastestRecommendation.doctor.assets[].secured boolean Optional
lastestRecommendation.doctor.assets[].thumbURL string Optional
lastestRecommendation.doctor.assets[].type string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
lastestRecommendation.doctor.assets[].updated boolean Optional
lastestRecommendation.doctor.companyId string Optional
lastestRecommendation.doctor.created int64 Optional
lastestRecommendation.doctor.degree string Optional
lastestRecommendation.doctor.deleted boolean Optional
lastestRecommendation.doctor.email string Optional
lastestRecommendation.doctor.fax string Optional
lastestRecommendation.doctor.firstName string Optional
lastestRecommendation.doctor.id string Optional
lastestRecommendation.doctor.importId string Optional
lastestRecommendation.doctor.lastName string Optional
lastestRecommendation.doctor.license string Optional
lastestRecommendation.doctor.modified int64 Optional
lastestRecommendation.doctor.notes[] array Optional
lastestRecommendation.doctor.notes[].created int64 Optional
lastestRecommendation.doctor.notes[].deleted boolean Optional
lastestRecommendation.doctor.notes[].enableOnFleet boolean Optional
lastestRecommendation.doctor.notes[].id string Optional
lastestRecommendation.doctor.notes[].message string Optional
lastestRecommendation.doctor.notes[].modified int64 Optional
lastestRecommendation.doctor.notes[].updated boolean Optional
lastestRecommendation.doctor.notes[].writerId string Optional
lastestRecommendation.doctor.notes[].writerName string Optional
lastestRecommendation.doctor.phoneNumber string Optional
lastestRecommendation.doctor.searchText string Optional
lastestRecommendation.doctor.state string Optional
lastestRecommendation.doctor.updated boolean Optional
lastestRecommendation.doctor.website string Optional
lastestRecommendation.doctorId string Optional
lastestRecommendation.expirationDate int64 Optional
lastestRecommendation.frontPhoto object CompanyAsset Optional
lastestRecommendation.frontPhoto.active boolean Optional
lastestRecommendation.frontPhoto.assetType string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
lastestRecommendation.frontPhoto.companyId string Optional
lastestRecommendation.frontPhoto.created int64 Optional
lastestRecommendation.frontPhoto.deleted boolean Optional
lastestRecommendation.frontPhoto.id string Optional
lastestRecommendation.frontPhoto.key string Optional
lastestRecommendation.frontPhoto.largeURL string Optional
lastestRecommendation.frontPhoto.largeX2URL string Optional
lastestRecommendation.frontPhoto.mediumURL string Optional
lastestRecommendation.frontPhoto.modified int64 Optional
lastestRecommendation.frontPhoto.name string Optional
lastestRecommendation.frontPhoto.origURL string Optional
lastestRecommendation.frontPhoto.priority int32 Optional
lastestRecommendation.frontPhoto.publicURL string Optional
lastestRecommendation.frontPhoto.secured boolean Optional
lastestRecommendation.frontPhoto.thumbURL string Optional
lastestRecommendation.frontPhoto.type string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
lastestRecommendation.frontPhoto.updated boolean Optional
lastestRecommendation.id string Optional
lastestRecommendation.issueDate int64 Optional
lastestRecommendation.limitExemption boolean Optional
lastestRecommendation.modified int64 Optional
lastestRecommendation.recommendationNumber string Optional
lastestRecommendation.state string Optional
lastestRecommendation.temporary boolean Optional
lastestRecommendation.updated boolean Optional
lastestRecommendation.verified boolean Optional
lastestRecommendation.verifyMethod string

Possible values are:

  • DEFAULT
  • MANUAL
  • HELLOMD
 Optional
lastestRecommendation.verifyPhoneNumber string Optional
lastestRecommendation.verifyWebsite string Optional
lifetimePoints number Optional
loyaltyPoints number Optional
marketingSource string Optional
medical boolean Optional
memberGroup object MemberGroup Optional
memberGroup.active boolean Optional
memberGroup.companyId string Optional
memberGroup.created int64 Optional
memberGroup.defaultGroup boolean Optional
memberGroup.deleted boolean Optional
memberGroup.dirty boolean Optional
memberGroup.discount number Optional
memberGroup.discountType string

Possible values are:

  • Cash
  • Percentage
  • FinalPrice
 Optional
memberGroup.enablePromotion boolean Optional
memberGroup.id string Optional
memberGroup.memberCount int32 Optional
memberGroup.memberCountEmailOptIn int32 Optional
memberGroup.memberCountTextOptIn int32 Optional
memberGroup.modified int64 Optional
memberGroup.name string Optional
memberGroup.promotionId string Optional
memberGroup.promotionShopMap object Optional
memberGroup.promotionShopMap.<key> map of string Optional
memberGroup.shopId string Optional
memberGroup.updated boolean Optional
memberGroupId string Optional
middleName string Optional
modified int64 Optional
notes[] array Optional
notes[].created int64 Optional
notes[].deleted boolean Optional
notes[].enableOnFleet boolean Optional
notes[].id string Optional
notes[].message string Optional
notes[].modified int64 Optional
notes[].updated boolean Optional
notes[].writerId string Optional
notes[].writerName string Optional
preferences[] array Optional
preferences[].companyId string Optional
preferences[].created int64 Optional
preferences[].deleted boolean Optional
preferences[].id string Optional
preferences[].modified int64 Optional
preferences[].name string Optional
preferences[].updated boolean Optional
primaryPhone string Optional
qbCustomerRef[] array of object Optional
qbCustomerRef[].<key> map of string Optional
recentProducts[] array of string Optional
recommendationExpired boolean Optional
recommendationExpiryLeft int64 Optional
recommendations[] array Optional
recommendations[].assets[] array Optional
recommendations[].assets[].active boolean Optional
recommendations[].assets[].assetType string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
recommendations[].assets[].companyId string Optional
recommendations[].assets[].created int64 Optional
recommendations[].assets[].deleted boolean Optional
recommendations[].assets[].id string Optional
recommendations[].assets[].key string Optional
recommendations[].assets[].largeURL string Optional
recommendations[].assets[].largeX2URL string Optional
recommendations[].assets[].mediumURL string Optional
recommendations[].assets[].modified int64 Optional
recommendations[].assets[].name string Optional
recommendations[].assets[].origURL string Optional
recommendations[].assets[].priority int32 Optional
recommendations[].assets[].publicURL string Optional
recommendations[].assets[].secured boolean Optional
recommendations[].assets[].thumbURL string Optional
recommendations[].assets[].type string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
recommendations[].assets[].updated boolean Optional
recommendations[].companyId string Optional
recommendations[].created int64 Optional
recommendations[].deleted boolean Optional
recommendations[].doctor object Doctor Optional
recommendations[].doctor.active boolean Optional
recommendations[].doctor.address object Address Optional
recommendations[].doctor.address.address string Optional
recommendations[].doctor.address.addressLine2 string Optional
recommendations[].doctor.address.city string Optional
recommendations[].doctor.address.companyId string Optional
recommendations[].doctor.address.country string Optional
recommendations[].doctor.address.created int64 Optional
recommendations[].doctor.address.deleted boolean Optional
recommendations[].doctor.address.id string Optional
recommendations[].doctor.address.latitude number Optional
recommendations[].doctor.address.longitude number Optional
recommendations[].doctor.address.modified int64 Optional
recommendations[].doctor.address.state string Optional
recommendations[].doctor.address.updated boolean Optional
recommendations[].doctor.address.zipCode string Optional
recommendations[].doctor.assets[] array Optional
recommendations[].doctor.assets[].active boolean Optional
recommendations[].doctor.assets[].assetType string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
recommendations[].doctor.assets[].companyId string Optional
recommendations[].doctor.assets[].created int64 Optional
recommendations[].doctor.assets[].deleted boolean Optional
recommendations[].doctor.assets[].id string Optional
recommendations[].doctor.assets[].key string Optional
recommendations[].doctor.assets[].largeURL string Optional
recommendations[].doctor.assets[].largeX2URL string Optional
recommendations[].doctor.assets[].mediumURL string Optional
recommendations[].doctor.assets[].modified int64 Optional
recommendations[].doctor.assets[].name string Optional
recommendations[].doctor.assets[].origURL string Optional
recommendations[].doctor.assets[].priority int32 Optional
recommendations[].doctor.assets[].publicURL string Optional
recommendations[].doctor.assets[].secured boolean Optional
recommendations[].doctor.assets[].thumbURL string Optional
recommendations[].doctor.assets[].type string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
recommendations[].doctor.assets[].updated boolean Optional
recommendations[].doctor.companyId string Optional
recommendations[].doctor.created int64 Optional
recommendations[].doctor.degree string Optional
recommendations[].doctor.deleted boolean Optional
recommendations[].doctor.email string Optional
recommendations[].doctor.fax string Optional
recommendations[].doctor.firstName string Optional
recommendations[].doctor.id string Optional
recommendations[].doctor.importId string Optional
recommendations[].doctor.lastName string Optional
recommendations[].doctor.license string Optional
recommendations[].doctor.modified int64 Optional
recommendations[].doctor.notes[] array Optional
recommendations[].doctor.notes[].created int64 Optional
recommendations[].doctor.notes[].deleted boolean Optional
recommendations[].doctor.notes[].enableOnFleet boolean Optional
recommendations[].doctor.notes[].id string Optional
recommendations[].doctor.notes[].message string Optional
recommendations[].doctor.notes[].modified int64 Optional
recommendations[].doctor.notes[].updated boolean Optional
recommendations[].doctor.notes[].writerId string Optional
recommendations[].doctor.notes[].writerName string Optional
recommendations[].doctor.phoneNumber string Optional
recommendations[].doctor.searchText string Optional
recommendations[].doctor.state string Optional
recommendations[].doctor.updated boolean Optional
recommendations[].doctor.website string Optional
recommendations[].doctorId string Optional
recommendations[].expirationDate int64 Optional
recommendations[].frontPhoto object CompanyAsset Optional
recommendations[].frontPhoto.active boolean Optional
recommendations[].frontPhoto.assetType string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
recommendations[].frontPhoto.companyId string Optional
recommendations[].frontPhoto.created int64 Optional
recommendations[].frontPhoto.deleted boolean Optional
recommendations[].frontPhoto.id string Optional
recommendations[].frontPhoto.key string Optional
recommendations[].frontPhoto.largeURL string Optional
recommendations[].frontPhoto.largeX2URL string Optional
recommendations[].frontPhoto.mediumURL string Optional
recommendations[].frontPhoto.modified int64 Optional
recommendations[].frontPhoto.name string Optional
recommendations[].frontPhoto.origURL string Optional
recommendations[].frontPhoto.priority int32 Optional
recommendations[].frontPhoto.publicURL string Optional
recommendations[].frontPhoto.secured boolean Optional
recommendations[].frontPhoto.thumbURL string Optional
recommendations[].frontPhoto.type string

Possible values are:

  • Photo
  • Document
  • Kml
 Optional
recommendations[].frontPhoto.updated boolean Optional
recommendations[].id string Optional
recommendations[].issueDate int64 Optional
recommendations[].limitExemption boolean Optional
recommendations[].modified int64 Optional
recommendations[].recommendationNumber string Optional
recommendations[].state string Optional
recommendations[].temporary boolean Optional
recommendations[].updated boolean Optional
recommendations[].verified boolean Optional
recommendations[].verifyMethod string

Possible values are:

  • DEFAULT
  • MANUAL
  • HELLOMD
 Optional
recommendations[].verifyPhoneNumber string Optional
recommendations[].verifyWebsite string Optional
regionId string Optional
searchText string Optional
sex string

Possible values are:

  • MALE
  • FEMALE
  • OTHER
 Optional
shopId string Optional
startDate int64 Optional
status string

Possible values are:

  • Active
  • Pending
  • Inactive
 Optional
tags[] array of string Optional
textOptIn boolean Optional
updated boolean Optional
uppercaseCity string Optional

Response

The following HTTP status codes may be returned, optionally with a response resource.

Status code Description Resource
200 OK

successful operation

 Member

Explore this API

memberId
body
Request Content-Type
Response Content-Type
Try it out!