API Reference

Create an App Assignment

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

Overview

Create a new app assignment to a business, package or directory.

Available for Directory Tokens and Internal Tokens only. Staff and Business tokens are not supported and will return 401 Unauthorized.

Prerequisites

  • The app specified by app_code_name must already exist and belong to the authenticated directory
  • The directory_uid parameter is optional when using Directory Token (auto-determined from token). If provided, must match the directory associated with your authentication token.
Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
enum
required

The type of entity this app is assigned to

Allowed:
string
required

The uid of the entity this app is assigned to

string
required

The unique identifier of the app. Must use alphanumeric characters only (no spaces or special characters). The app must exist and belong to the authenticated directory.

string

The uid of the directory this app is assigned to. Optional when using Directory Token - will be auto-determined from the token if omitted. If provided, must match the directory associated with your authentication token.

settings
object
required

Optional settings for the app assignment

Responses

400

Bad request. Invalid input data.

401

Unauthorized. The bearer token is missing or invalid.

403

Forbidden. You do not have access to this resource.

500

Internal server error.

Updated 3 months 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 3 months ago