BLAZE Developer API: Add New Member

Request

POST http:///api/v1/partner/members

Request body

The request body takes a complete MembershipAddRequest 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"
        }
    ],
    "anonymous": "boolean",
    "careGivers": [
        "string"
    ],
    "consumerType": "string",
    "dob": "int64",
    "doctorImportId": "string",
    "email": "string",
    "emailOptIn": "boolean",
    "enableLoyalty": "boolean",
    "enabledCannabisLimit": "boolean",
    "enabledCareGiver": "boolean",
    "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",
    "loyaltyPoints": "number",
    "marketingSource": "string",
    "medical": "boolean",
    "memberGroupId": "string",
    "middleName": "string",
    "notes": [
        {
            "created": "int64",
            "deleted": "boolean",
            "enableOnFleet": "boolean",
            "id": "string",
            "message": "string",
            "modified": "int64",
            "updated": "boolean",
            "writerId": "string",
            "writerName": "string"
        }
    ],
    "photoId": "string",
    "primaryPhone": "string",
    "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"
        }
    ],
    "searchText": "string",
    "sex": "string",
    "startDate": "int64",
    "status": "string",
    "tags": [
        "string"
    ],
    "textOptIn": "boolean"
}

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
anonymous	boolean		Optional
careGivers[]	array of string		Optional
consumerType	string	Possible values are: `Other` `AdultUse` `MedicinalState` `MedicinalThirdParty`	Optional
dob	int64		Optional
doctorImportId	string		Optional
email	string		Optional
emailOptIn	boolean		Optional
enableLoyalty	boolean		Optional
enabledCannabisLimit	boolean		Optional
enabledCareGiver	boolean		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
loyaltyPoints	number		Optional
marketingSource	string		Optional
medical	boolean		Optional
memberGroupId	string		Optional
middleName	string		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
photoId	string		Optional
primaryPhone	string		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
searchText	string		Optional
sex	string	Possible values are: `MALE` `FEMALE` `OTHER`	Optional
startDate	int64		Optional
status	string	Possible values are: `Active` `Pending` `Inactive`	Optional
tags[]	array of string		Optional
textOptIn	boolean		Optional

Response

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

Status code	Description	Resource
200	OK successful operation	Member

Add New Member

Request

Request body

Properties

Response

Explore this API

Request

Response status

Response body

Response headers