Add Member Data

Add Member Data

Purpose

To add new Member/location to your organization.

Request URL

https://live.membroz.com/api/members

Request Method

POST
Note
  • Send authkey in https header
  • You can add only one member per POST request.
  • You must use only Field API names in the input. You can obtain the field API names from Fields metadata API
  • Enterprise customer can replace domain name with their hosting Url. for example https://app.xyz.com/api/members
  • API will return inserted member data in JSON format or error message.

Request JSON

Attribute Data Type Mandatory Description
membername text yes member/location/company name
currency text
country text
timezone text
city text
companyphone text
contactperson text

Sample Request

curl --location --request POST 'https://live.membroz.com/api/members' \
--header 'authkey: XXXXXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{"property": {
            "fullname": "kkkkk"
            
          
        },
          "limit": 1
}
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{\"property\": {\r\n            \"fullname\": \"kkkkk\"\r\n            \r\n          \r\n        },\r\n          \"limit\": 1\r\n}");
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/members")
  .method("POST", body)
  .addHeader("authkey", "XXXXXXXXXX")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
 "https://live.membroz.com/api/members",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS =>"{\"property\": {\r\n            \"fullname\": \"kkkkk\"\r\n            \r\n          \r\n        },\r\n          \"limit\": 1\r\n}",
  CURLOPT_HTTPHEADER => array(
    "authkey: XXXXXXXXXX",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

import requests

url = "https://live.membroz.com/api/members"

payload = "{\"property\": {\r\n            \"fullname\": \"kkkkk\"\r\n            \r\n          \r\n        },\r\n          \"limit\": 1\r\n}"
headers = {
  'authkey': 'XXXXXXXXXX',
  'Content-Type': 'application/json'
}

response = requests.request("POST", url, headers=headers, data = payload)

print(response.text.encode('utf8'))

require "uri"
require "net/http"

url = URI("https://live.membroz.com/api/members")

https = Net::HTTP.new(url.host, url.port);
https.use_ssl = true

request = Net::HTTP::Post.new(url)
request["authkey"] = "XXXXXXXXXX"
request["Content-Type"] = "application/json"
request.body = "{\"property\": {\r\n            \"fullname\": \"kkkkk\"\r\n            \r\n          \r\n        },\r\n          \"limit\": 1\r\n}"

response = https.request(request)
puts response.read_body

var client = new RestClient("https://live.membroz.com/api/members");
client.Timeout = -1;
var request = new RestRequest(Method.POST);
request.AddHeader("authkey", "XXXXXXXXXX");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\"property\": {\r\n            \"fullname\": \"kkkkk\"\r\n            \r\n          \r\n        },\r\n          \"limit\": 1\r\n}",  ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
Console.WriteLine(response.Content);

Possible Errors

HTTP Status Error Code Message Reason
permission denied 403 You do not have permission

Sample Response

{
    "firsttimelogin": true,
    "paymentterms": [],
    "status": "active",
    "_id": "5f6d80cfc97e67698f6687eb",
    "membernumber": "SAMPL10123",
    "anroiddevices": [],
    "iosdevices": [],
    "addedby": "5e954c7b9df11624f81e785b",
    "branchid": "5e954c7b9df11624f81e7859",
    "username": "SAMPL10123",
    "password": "$2a$10$UBLTgClcDDIG2JCmfeK8peDw2wIa5D4vjNNno6LMZVmZM5/derHii",
    "role": "59c1fb52b985482b2c610cee",
    "addons": [],
    "property": {
        "fullname": "kkkkk"
    },
    "createdAt": "2020-09-25T05:31:59.691Z",
    "updatedAt": "2020-09-25T05:31:59.691Z",
    "fullname": "kkkkk ",
    "membernumbername": "SAMPL10123 | kkkkk ",
    "age": 0,
    "updatedby": "5e954c7b9df11624f81e785b"
}