Skip to main content
PATCH
Update config

Path Parameters

configShortId
string
required
Pattern: ^cfg(-.+_.+|_.+)$

Body

application/json
name
string
Required string length: 2 - 100
description
string | null

Pass null to clear it.

Maximum string length: 2000
data
object

Replacement values, in the same shape as create_config for the config's type. Replaces all values; the generated inbox email of EMAIL_PASSWORD and FIXED_EMAIL configs is kept. ONE_TIME_USE_ITEMS pools are edited in the dashboard.

applicationShortId
string | null

Application to scope the config to. Pass null to make it available to every application.

Pattern: ^app(-.+_.+|_.+)$
projectShortId
string

Target a specific project by its prefixed short ID (proj-slug_shortId or proj_shortId), as returned by the projects API. Required for organization-scoped API keys; project-scoped keys may only pass their own project's short ID.

Pattern: ^proj(-.+_.+|_.+)$

Response

200 - application/json

The request has succeeded.

success
boolean
required
config
object
required