Skip to main content

Copy Business Locations

PATCH /api/v1/businesses/{businessId}/copy/locations

Description

Copy business locations.

Path Parameters

NameTypeDescription
businessIdstringThe ID of the business (path)

Request Body

  • Content Type: application/json
{
"userId": "string",
"actionBy": "string",
"businessId": "string",
"locations": [
{
"branchName": "string",
"stateCode": "string",
"cityName": "string",
"latitude": 0,
"longitude": 0,
"extraLocationPrice": 0,
"address": "string"
}
]
}

Response Code: 200 - OK

Description

Business locations copied successfully.

Response Fields

FieldTypeDescription
statusbooleanIndicates if the operation was successful
statusCodeintegerStatus code
messagestringResponse message
dataobjectData related to the business locations
errorsarrayList of error messages, if any

Example

{
"status": true,
"statusCode": 0,
"message": "Business locations copied successfully",
"data": {},
"errors": []
}

Headers

Content-TypeValue
apiKey{{apiKey}}

Body

{
"userId": "usr123",
"actionBy": "admin",
"businessId": "biz456",
"locations": [
{
"branchName": "Main Branch",
"stateCode": "CA",
"cityName": "San Francisco",
"latitude": 37.7749,
"longitude": -122.4194,
"extraLocationPrice": 100.00,
"address": "123 Market Street"
}
]
}

🔑 Authentication bearer

ParamValueType
token{{accessCode}}string

LANGUAGE

AUTHORIZATION

Bearer

CURL REQUEST


curl --request PATCH \ 
--url /api/v1/businesses/{businessId}/copy/locations \
--header 'accept: application/json' \
--header 'content-type: application/json'

RESPONSE


Click Try It! to start a request and see the response here!