POST
/
api
/
branches
{
  "id": 1,
  "name": "Main Branch",
  "code": "BR001",
  "address": "123 Main Street",
  "city": "New York",
  "country": "USA",
  "phoneNumber": "+1-555-123-4567",
  "email": "[email protected]",
  "website": "https://www.example.com/branch",
  "primary": true,
  "createdAt": "2024-03-20T10:00:00Z",
  "updatedAt": "2024-03-20T10:00:00Z"
}

Headers

​
Authorization
string
required

Value must be 'Bearer <token>' where <token> is an API key prefixed with 'bc_' or a JWT token.

Example:

"Bearer bc_1234567890abcdef"

​
organization-id
string
required

Required if Authorization is a JWT token. The organization ID to operate within.

Body

application/json

Response

200
application/json

The branch has been successfully created.

The response is of type object.