Skip to content
Retidal Docs

Update a pixel config (ADMIN)

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
projectId
required
string
platformId
required
string

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json

Partial update; at least one field required. Masked credential values (••••••…) are ignored.

object
>= 1 properties
name
string
>= 1 characters
credentials
object
key
additional properties
string
>= 1 characters
eventMapping
object | null
isActive
boolean
Examplegenerated
json
{
  "name": "example",
  "credentials": {
    "additionalProperty": "example"
  },
  "eventMapping": "example",
  "isActive": true
}

Responses

Section titled “Responses”

200

Section titled “200”

{ updated, platform }. Some keys are dynamic — PUT and PATCH share the exact SAME handler (updateHandler) and therefore return an IDENTICAL body. Response includes a constant updated: 1 alongside the record. Credentials in the response are masked identically to the list endpoint (“••••••” + last 4 chars of the decrypted value) — no plaintext. Submitted credential values that are already masked (prefix “••••••”) are ignored and the previously stored ciphertext is retained. 404 {error:“像素不存在”} when the platform id is missing/not found; 400 {error:“像素配置无效”, issues:[…]} on validation failure.

Media typeapplication/json
object
updated
required
integer
Allowed values: 1
platform
required
object
id
required
string
projectId
required
string
platform
required
string
Allowed values: BAIDU DOUYIN TENCENT KUAISHOU XIAOHONGSHU BILIBILI WEIBO GOOGLE META TIKTOK BING TWITTER LINKEDIN SNAPCHAT PINTEREST KWAI GOOGLE_MEASUREMENT BIGO TRAFFICSTARS TRAFFICJUNKY PROPELLERADS DEEPCLICK MGSKY ADJUST XIAOBU OKSPIN SNAPTUBE APPLUCK MACAN
name
required
string
credentials
required

REDACTED. Keys are the stored credential field names (dynamic per platform); each value is “••••••” optionally suffixed with the last 4 characters of the decrypted secret. Never full plaintext.

object
key
additional properties
string
eventMapping
required

Dynamic map of internal event name -> platform event name; may be {}.

object
key
additional properties
string
isActive
required
boolean
lastError
required
string
nullable
createdAt
required

ISO-8601 UTC timestamp.

string
updatedAt
required

ISO-8601 UTC timestamp.

string

404

Section titled “404”

Platform not found

Media typeapplication/json
object
error
required

Human-readable error message.

string
message
string
Examplegenerated
json
{
  "error": "example",
  "message": "example"
}