Update

Update

Purpose

To update the branch/location detail of your organization.

Request URL

https://live.membroz.com/api/branches/[branchid]

Request Method

PUT
Note
  • Send authkey in https header
  • 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/branches
  • API return updated branch data in json format or return error message.

Request JSON

Attribute Data Type Mandatory Description
BRANCHID String Yes The record ID of the branch you want to update. it is pass in request
/api/branches/[branchid]

Sample Request

curl --location --request PUT 'https://live.membroz.com/api/branches/XXXXXXXXXX' \
--header 'authkey: XXXXXXX' \
--header 'Content-Type: application/json' \
--data-raw '{     
    "branchname": "New Branch",    
    "property": {
        "country": "India"
    },
    "currency": "Indian rupee",
    "membershipidformat": "LLLLLnnnnn",
    "startingnumber": "MEMBO10000",
    "createdAt": "2020-05-27T11:35:52.420Z",
    "updatedAt": "2020-08-15T16:30:28.212Z",
    "branchlogo": "https://res.cloudinary.com/dlopjt9le/image/upload/v1592808579/vkohnsxzlpcnxptcol7f.png",
    "country": "IN",
    "timezone": "UTC+05:30 Mumbai, Kolkata, Chennai, New Delhi",
    "city": "",
    "companyphone": "61982-77123",
    "contactperson": "Mahi Patel",
    "postcode": "",
    "supportemail": "support@utopia.com",    
    "vatnumber": "A12-827-7640"
}
'
OkHttpClient client = new OkHttpClient().newBuilder()
  .build();
MediaType mediaType = MediaType.parse("application/json");
RequestBody body = RequestBody.create(mediaType, "{     \r\n    \"branchname\": \"New Branch\",    \r\n    \"property\": {\r\n        \"country\": \"India\"\r\n    },\r\n    \"currency\": \"Indian rupee\",\r\n    \"membershipidformat\": \"LLLLLnnnnn\",\r\n    \"startingnumber\": \"MEMBO10000\",\r\n    \"createdAt\": \"2020-05-27T11:35:52.420Z\",\r\n    \"updatedAt\": \"2020-08-15T16:30:28.212Z\",\r\n    \"branchlogo\": \"https://res.cloudinary.com/dlopjt9le/image/upload/v1592808579/vkohnsxzlpcnxptcol7f.png\",\r\n    \"country\": \"IN\",\r\n    \"timezone\": \"UTC+05:30 Mumbai, Kolkata, Chennai, New Delhi\",\r\n    \"city\": \"\",\r\n    \"companyphone\": \"61982-77123\",\r\n    \"contactperson\": \"Mahi Patel\",\r\n    \"postcode\": \"\",\r\n    \"supportemail\": \"support@utopia.com\",    \r\n    \"vatnumber\": \"A12-827-7640\"\r\n}\r\n");
Request request = new Request.Builder()
  .url("https://live.membroz.com/api/branches/XXXXXXXXXXX")
  .method("PUT", body)
  .addHeader("authkey", "XXXXXXX")
  .addHeader("Content-Type", "application/json")
  .build();
Response response = client.newCall(request).execute();
 "https://live.membroz.com/api/branches/XXXXXXXXXXX",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 0,
  CURLOPT_FOLLOWLOCATION => true,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "PUT",
  CURLOPT_POSTFIELDS =>"{     \r\n    \"branchname\": \"New Branch\",    \r\n    \"property\": {\r\n        \"country\": \"India\"\r\n    },\r\n    \"currency\": \"Indian rupee\",\r\n    \"membershipidformat\": \"LLLLLnnnnn\",\r\n    \"startingnumber\": \"MEMBO10000\",\r\n    \"createdAt\": \"2020-05-27T11:35:52.420Z\",\r\n    \"updatedAt\": \"2020-08-15T16:30:28.212Z\",\r\n    \"branchlogo\": \"https://res.cloudinary.com/dlopjt9le/image/upload/v1592808579/vkohnsxzlpcnxptcol7f.png\",\r\n    \"country\": \"IN\",\r\n    \"timezone\": \"UTC+05:30 Mumbai, Kolkata, Chennai, New Delhi\",\r\n    \"city\": \"\",\r\n    \"companyphone\": \"61982-77123\",\r\n    \"contactperson\": \"Mahi Patel\",\r\n    \"postcode\": \"\",\r\n    \"supportemail\": \"support@utopia.com\",    \r\n    \"vatnumber\": \"A12-827-7640\"\r\n}\r\n",
  CURLOPT_HTTPHEADER => array(
    "authkey: XXXXXXX",
    "Content-Type: application/json"
  ),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;
import requests

url = "https://live.membroz.com/api/branches/XXXXXXX"

payload = "{     \r\n    \"branchname\": \"New Branch\",    \r\n    \"property\": {\r\n        \"country\": \"India\"\r\n    },\r\n    \"currency\": \"Indian rupee\",\r\n    \"membershipidformat\": \"LLLLLnnnnn\",\r\n    \"startingnumber\": \"MEMBO10000\",\r\n    \"createdAt\": \"2020-05-27T11:35:52.420Z\",\r\n    \"updatedAt\": \"2020-08-15T16:30:28.212Z\",\r\n    \"branchlogo\": \"https://res.cloudinary.com/dlopjt9le/image/upload/v1592808579/vkohnsxzlpcnxptcol7f.png\",\r\n    \"country\": \"IN\",\r\n    \"timezone\": \"UTC+05:30 Mumbai, Kolkata, Chennai, New Delhi\",\r\n    \"city\": \"\",\r\n    \"companyphone\": \"61982-77123\",\r\n    \"contactperson\": \"Mahi Patel\",\r\n    \"postcode\": \"\",\r\n    \"supportemail\": \"support@utopia.com\",    \r\n    \"vatnumber\": \"A12-827-7640\"\r\n}\r\n"
headers = {
  'authkey': 'XXXXXXX',
  'Content-Type': 'application/json'
}

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

print(response.text.encode('utf8'))
require "uri"
require "net/http"

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

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

request = Net::HTTP::PUT.new(url)
request["authkey"] = "XXXXXXX"
request["Content-Type"] = "application/json"
request.body = "{     \r\n    \"branchname\": \"New Branch\",    \r\n    \"property\": {\r\n        \"country\": \"India\"\r\n    },\r\n    \"currency\": \"Indian rupee\",\r\n    \"membershipidformat\": \"LLLLLnnnnn\",\r\n    \"startingnumber\": \"MEMBO10000\",\r\n    \"createdAt\": \"2020-05-27T11:35:52.420Z\",\r\n    \"updatedAt\": \"2020-08-15T16:30:28.212Z\",\r\n    \"branchlogo\": \"https://res.cloudinary.com/dlopjt9le/image/upload/v1592808579/vkohnsxzlpcnxptcol7f.png\",\r\n    \"country\": \"IN\",\r\n    \"timezone\": \"UTC+05:30 Mumbai, Kolkata, Chennai, New Delhi\",\r\n    \"city\": \"\",\r\n    \"companyphone\": \"61982-77123\",\r\n    \"contactperson\": \"Mahi Patel\",\r\n    \"postcode\": \"\",\r\n    \"supportemail\": \"support@utopia.com\",    \r\n    \"vatnumber\": \"A12-827-7640\"\r\n}\r\n"

response = https.request(request)
puts response.read_body
var client = new RestClient("https://live.membroz.com/api/branches/XXXXXXXX");
client.Timeout = -1;
var request = new RestRequest(Method.PUT);
request.AddHeader("authkey", "XXXXXXX");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{     \r\n    \"branchname\": \"New Branch\",    \r\n    \"property\": {\r\n        \"country\": \"India\"\r\n    },\r\n    \"currency\": \"Indian rupee\",\r\n    \"membershipidformat\": \"LLLLLnnnnn\",\r\n    \"startingnumber\": \"MEMBO10000\",\r\n    \"createdAt\": \"2020-05-27T11:35:52.420Z\",\r\n    \"updatedAt\": \"2020-08-15T16:30:28.212Z\",\r\n    \"branchlogo\": \"https://res.cloudinary.com/dlopjt9le/image/upload/v1592808579/vkohnsxzlpcnxptcol7f.png\",\r\n    \"country\": \"IN\",\r\n    \"timezone\": \"UTC+05:30 Mumbai, Kolkata, Chennai, New Delhi\",\r\n    \"city\": \"\",\r\n    \"companyphone\": \"61982-77123\",\r\n    \"contactperson\": \"Mahi Patel\",\r\n    \"postcode\": \"\",\r\n    \"supportemail\": \"support@utopia.com\",    \r\n    \"vatnumber\": \"A12-827-7640\"\r\n}\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

{
    "status": "active",
    "_id": "XXXXXXXXXX",
    "branchname": "New Branch",
    "branchlogo": "https://res.cloudinary.com/dlopjt9le/image/upload/v1592808579/vkohnsxzlpcnxptcol7f.png",
    "currency": "Indian rupee",
    "supportemail": "support@utopia.com",
    "vatnumber": "A12-827-7640",
    "companyphone": "61982-77123",
    "contactperson": "Mahi Patel",
    "postcode": "",
    "city": "",
    "country": "IN",
    "timezone": "UTC+05:30 Mumbai, Kolkata, Chennai, New Delhi",
    "property": {
        "country": "India"
    },
    "createdAt": "2020-09-02T12:16:49.944Z",
    "updatedAt": "2020-09-02T12:22:13.132Z",
    "updatedby": "5ece509879b40e583fa638f6",
    "addedby": "5ece509879b40e583fa638f6",
    "membershipidformat": "LLLLLnnnnn",
    "startingnumber": "MEMBO10000"
}
Send Message
Hello!
How can we help!