Skip to content
API Reference/
/
Connect a business

Connect a business

Request

Creates a business connection between the business and the external entity on directory (e.g. brand page for FB)

Security
X-API-KEY or Authorization
Path
directoryTypestringrequired

Type of the directory

businessIdstringrequired

Id of the Business

Bodyapplication/json

Business connection parameters

connectionIdstring

Connection id that must be passed for directories like Twitter

accountIdinteger, (int64)

Directory account which will be used for establishing connection

curl -i -X POST \
  'https://uberall.com/api/business-connections/{directoryType}/connect/{businessId}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-KEY: YOUR_API_KEY_HERE' \
  -d '{
    "connectionId": "string",
    "accountId": 0
  }'

Responses

Business successfully connected

Body*/*
statusstringrequired
Enum:"SUCCESS""PENDING""QUOTA_LIMIT_EXCEED""NOT_AUTHORIZED""FORBIDDEN""BAD_ACCESS_TOKEN""BAD_PRIVATE_KEY""BAD_PUBLIC_KEY""MISSING_PARAMETER""INVALID_PARAMETER"
messagestring

(optional) Holds further information about the response

warningsArray of strings

(optional) Holds further warnings

responseobjectrequired

The actual response object of the response

Response
{
  "status": "SUCCESS",
  "message": "string",
  "warnings": [
    "string"
  ],
  "response": {}
}