API Reference

Create an App Business Mapping

post
https://api.vcita.biz/v3/apps/app_business_mappings

Create a new mapping between a vcita business and third-party app identifiers for a specific integrated app. Available for Directory tokens.

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

Request body for creating an app business mapping. Omits backend-managed fields (uid, created_at, updated_at). directory_uid is resolved from the Directory token when omitted.

string
required

Unique identifier of the vcita business being mapped (e.g., "d290f1ee6c544b01").

string

The uid of the directory (partner) that owns this mapping. Optional when using Directory Token — auto-determined from the token if omitted. If provided, must match the directory associated with your authentication token. May be supplied for future Internal token support (e.g., "dir_partner_xyz").

string
required

Code name of the third-party integrated app this mapping applies to (e.g., "yext").

string
required

Third-party business identifier for the mapped business in the external app (e.g., "yext-business-id-42").

string | null

Optional third-party user identifier for the mapped business in the external app (e.g., "yext-user-code-42" or null).

Responses

Updated about 2 hours ago

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

Updated about 2 hours ago