Edit Custom Parameter

post

https://api.primis.tech/api/v1/customParameter/edit

Updates an existing custom parameter.

Prerequisites

Authenticate and obtain an access token using your API credentials. Use
this token to authorize all subsequent API requests.

Request Parameters

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

integer

required

ID of the custom parameter to edit.

managedUserId

integer

User ID of the publisher (must exist in DB and be a Publisher or Publisher Plus).

keyName

string

required

length ≥ 1

Parameter name (min length: 1).

mandatory

integer

required

Indicates if the parameter is required (0 = no, 1 = yes).

createdBy

string

Name of creator. Attached automatically on creation. It is either the managed user or (if managedUserId not set) a logged-in user.

type

string

enum

required

Either text or list.

Allowed:

videoId

integer | null

Defaults to null

If specified, parameter will be tied to this video.

status

string

enum

Defaults to active

One of: active, inActive, delete.

Allowed:

configuration

object

Configuration object. Required when type is list; omitted for text parameters.

Response

Language

Credentials

Bearer

JWT

Loading…

Response

Click Try It! to start a request and see the response here! Or choose an example:

application/json

200Successfully updated the custom parameter