Skip to main content
POST
cURL
Creating a variable whose name already exists in the project returns 409 Conflict. To set a value whether or not the variable exists yet:
  1. Call List Variables with name set to the variable name. The filter matches partial names, so look for a result whose name is an exact match. If none matches and next is not null, pass next as cursor with the same projectId and name, and repeat until you find the exact match or there are no more pages.
  2. If you find an exact match, update it by id. Otherwise, create it.
When you embed Activepieces, each of your tenants maps to a project. Find the tenant’s projectId with GET /v1/projects?externalId=<your tenant id>.

Authorizations

Authorization
string
header
required

Use your api key generated from the admin console

Body

application/json
projectId
string
required
name
string
required
Minimum string length: 1
Pattern: ^[a-zA-Z0-9_]+$
value
string
required
Minimum string length: 1
metadata
object

Response

201 - application/json

Default Response

id
string
required
created
string
required
updated
string
required
name
string
required
projectId
string
required
platformId
string
required
ownerId
string | null
owner
object | null
metadata
object | null