Create or replace business info

All fields optional. An empty body, or one with only unknown fields, is a no-op returning 200.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

Request parameters

ParameterTypeRequiredInDescription
AuthorizationstringYesHeaderPartner app token, sent raw. Bearer <token> is also accepted.
Content-TypestringYesHeaderapplication/json
appIdstring (uuid)YesPathPartner Portal app id. Stands in for Meta's entity_id.
payment_methodstringNoBodyAccepted payment methods.
return_policystringNoBodyReturn policy text.
purchase_infostringNoBodyHow to buy.
delivery_and_shippingstringNoBodyDelivery and shipping terms.
business_descriptionstringNoBodyWhat the business does.
contact_infoobjectNoBodyContact details the agent may share.
contact_info.emailstringNoBodySupport email.
contact_info.hours_of_operationstringNoBodyOpening hours.
contact_info.addressstringNoBodyPostal address.

Example request

curl --location --request PUT 'https://partner.gupshup.io/partner/app/<appId>/bizai/agent_config/business_info' \
  --header 'Authorization: <PARTNER_APP_TOKEN>' \
  --header 'Content-Type: application/json' \
  --data '{
  "payment_method": "Credit cards, PayPal",
  "return_policy": "30-day returns",
  "purchase_info": "Order online or call",
  "delivery_and_shipping": "Free shipping on orders over $50",
  "business_description": "Your company description",
  "contact_info": {
    "email": "[email protected]",
    "hours_of_operation": "9AM-6PM EST",
    "address": "123 Main St, City, State 12345"
  }
}'

Response parameters — 200

No response body. Business info stored.

Example response — 200 OK

No response body.

Error responses

400 Bad Request — The app is not live, or WASS does not consider it live.

{
  "message": "App is not live.",
  "status": "error"
}

400 Bad Request — The app has no phone number attached. Checked before the live check.

{
  "message": "Phone id not found for the given App",
  "status": "error"
}

401 Unauthorized — Authorization is missing or invalid, belongs to another app, or appId is unknown or not a UUID.

{
  "status": "error",
  "message": "Unauthorised access to the resource. Please review request parameters and headers and retry"
}

405 Method Not Allowed — Any method other than GET, POST, PUT or DELETE, e.g. PATCH.

{
  "status": "error",
  "message": "Request method 'PATCH' is not supported"
}

429 Too Many Requests — More than 30 /bizai/** requests in 60 seconds for this app. The 31st is rejected.

{
  "status": "error",
  "message": "Too Many Requests"
}
Path Params
uuid
required

Partner Portal app id. Stands in for Meta's entity_id.

Body Params
string
string
string
string
string
contact_info
object
Responses
200

Business info stored.

429

Per-app rate limit exceeded. Retry after the 60-second window.

Language
Credentials
Header
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json