Update SDK Key

post

https://api.convert.com/api/v2/accounts/{account_id}/projects/{project_id}/sdk-keys/{sdk_key}/update

Partially update an SDK key, modifying only the specific fields provided in the request.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

account_id

integer

required

ID of the account that owns the retrieved/saved data

project_id

integer

required

ID of the project to be retrieved

sdk_key

string

required

ID of the SDK key to update

Body Params

Payload to update an existing SDK key

Request payload for updating an existing SDK key. This endpoint supports partial updates, allowing you to modify specific fields while keeping others unchanged. Only the fields you want to update need to be included in the request body.

name

string

length ≤ 100

A user-defined, friendly name for the SDK key to help identify its purpose or the application/service using it (e.g., "Production Backend API", "Staging iOS App").

environment

string

The specific environment within the Full Stack project that this SDK key is associated with (e.g., "production", "development", "staging"). The SDK will fetch configurations relevant to this environment. This must match one of the environments defined at the project level. KB: "The Environments Feature".

status

string

enum

Defaults to enabled

Indicates whether the SDK key is active and can be used for API authentication. When disabled, all requests using this key will be rejected.

Allowed:

selected_default

boolean

If true, this SDK key is marked as the default for its environment within the project. Only one SDK key can be default per project environment. When a key is set as default, any previously default key for the same environment will be automatically unset.

Responses

Language

Credentials

URL

Loading…

Response

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

application/json

200Details of a single SDK key, including its name, the key string itself, the environment it's for, and whether it uses a secret for authentication. The secret is only shown in full upon creation if auto-generated.

defaultIndicates an error occurred while processing the request. The code provides an HTTP status code, message offers a human-readable explanation or an array of validation errors, and fields (if present) specifies which input fields were problematic.