24/7 Support: 800.608.6482

Navigation


Branch_Update

Requirements: Miva verion 10.00.00 or later.
This function allows you to updated an existng template branch

Request Body Parameters

Edit_Branch Type:
String
Title:
Branch To Edit
This is the branch you wish to update. This field is required only when renaming a branch.
Branch_Name Type:
String
Title:
Branch Name
Name of Branch. When passed along with Edit_Branch, this field is used to rename a branch
Branch_ID Type:
Number
Title:
Branch ID
Optional branch identifier. Only one of Edit_Branch, Branch_Name or Branch_ID need to be passed.
Color Type:
String
Title:
Branch Chip Color
Hex value of the color chip associated with the branch, including #. Cannot be blank. Default color is #20c171

Response Parameters

id Type:
Number
Title:
Id
Id of newely created Branch
immutable Type:
Boolean
Title:
Immutable
Boolean flag for immutable. Every store has a branch with cannot be deleted and is immutable.
branchkey Type:
String
Title:
Branch Key
Unique identifier for the branch. Used to generate preview link
name Type:
String
Title:
Branch Name
Name of Branch
color Type:
String
Title:
Branch Chip Color
Hex Value for Branch Color Chip. Used as a visual identifier in the Miva admin.
preview_url Type:
String
Title:
Preview URL
Preview URL for this specific Branch

Example Request

Example Response

Copyright © 1997 – 2026 Miva®, Miva Merchant®, MivaPay Vault®, Camp Miva®, Miva Connect®, Vexture℠, Miva, Inc. All Rights Reserved.