API

Common

Getting Started

User

Register New User
Login
Logout
Refresh Access Token
Get User Profile
Update Profile
Upload Avatar
Delete User
Reset Password
Reset Password by ID

User Token

List User Tokens
Add User Token
Update Default User Token
Delete User Token
Verify User Token
Reset Verification Code

User vAtom

Get vAtom
Get vAtoms by Ids
Get vAtom Inventory
Search vAtoms
Geo Discover Groups
Geo Discover vAtoms
Update vAtoms
Perform Action
Trash vAtom

User Activity

Get My Threads
Get My Thread Messages

Template

List Templates
Get Template
Create Template
Update Template
Delete Template

Template Variation

List Variations
Get Variation
Create Variation
Update Variation
Delete Variation

vAtom

Emit vAtom

Template Action

List Actions
Get Action
Register Action Handler
Register Action
Update Action
Delete Action

Template Face

List Faces
Register Face
Update Face
Delete Face

Asset

Upload Assets
Get Assets
Delete Assets

Emit vAtom

POST
https://api.blockv.io/v1/vatoms

Overview

You can emit vAtoms based on a template_variation and specify the quantity with num. The emitted vAtoms are in the inventory of the logged in admin user.

Emit vAtom Request

HTTP Headers

Content-Type: application/json App-Id: {app_id}

Payload Details

NameTypeDescription
template_variationstringName of the template variation that is used to emit the vAtom
numintegerNumber of vAtoms that will be emitted. Min. 1, Max. 10000

Sample Request

{
  "template_variation": "publisher_fqdn::MyFirstTemplate::MyFirstTemplateVariation",
  "num": 1
}

Emit vAtom Response

When the vAtoms are emitted successfully, the IDs of the emitted vAtoms are returned.

Return & Error Codes

ErrorTypeDescription
200httpEverything is OK
400httpInvalid data
403httpNot Authorized

payload Object

NameTypeDescription
num_createdintegerThe number of vAtoms that were created.
num_errorsintegerThe number of vAtoms that couldn't be created.
idsarrayAn array that contains the IDs of all the vAtoms that were created

Sample Response

{
    "payload": {
        "num_created": 1,
        "num_errors": 0,
        "ids": [
            "0000374c-2e55-4868-9db8-c0a6df5ced93"
        ]
    }
}
©2020 BLOCKv
Info