Request
Use the Access Token generated with user type as Sub-Account (OR) Private Integration Token of Sub-Account.
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123
Provide your bearer token in the Authorization header when making requests to protected resources.
Use the Access Token generated with user type as Agency.
Provide your bearer token in the Authorization header when making requests to protected resources.
Example: Authorization: Bearer 123
Provide your bearer token in the Authorization header when making requests to protected resources.
Path Parameters
businessId
stringExamples:
5DP4iH6HLkQsiKESj6rh
Headers
Authorization
stringAccess Token
Example:
Bearer 9c48df2694a849b6089f9d0d3513efe
Version
stringAPI Version
Allowed value:
2021-07-28
BODY
name
string
Example:
Microsoft
phone
string
Example:
+18832327657
email
string
Example:
john@deo.com
postalCode
string
Example:
12312312
website
string
Example:
www.xyz.com
address
string
Example:
street adress
state
string
Example:
new york
city
string
Example:
new york
country
string
Example:
us
description
string
Example:
business description
Responses
200
Successful response
success
boolean
Success Value
Example:
true
buiseness
object
Business Response
id
string
Business Id
Example:
63771dcac1116f0e21de8e12
name
string
Business Name
Example:
Microsoft
phone
string
phone number
email
string
Example:
abc@microsoft.com
website
string
website
Example:
microsoft.com
address
string
address
city
string
city
description
string
description
state
string
state
postalCode
string
postal code
country
string
country
Example:
united states
updatedBy
object
updated By
locationId
string
locaitonId
createdBy
object
Created By
createdAt
string<date-time>
Creation Time
updatedAt
string<date-time>
Last updation time
422
Unprocessable Entity
Body
statusCode
number
Example:
422
message
array[string]
Example:
["Unprocessable Entity"]
error
string
Example:
Unprocessable Entity
401
Unauthorized
Body
statusCode
number
Example:
401
message
string
Example:
Invalid token: access token is invalid
error
string
Example:
Unauthorized
400
Bad Request
Body
statusCode
number
Example:
400
message
string
Example:
Bad Request