AdBlast icon

AdBlast

Interact with AdBlast API

Environments → Update Environment

AI-generated

Summary

Update an existing environment in AdBlast.

Inputs

  • authenticationMethod (required) — Select either predefined credentials or a dynamic API key for authentication.
  • url (required) — The base URL for the AdBlast API, used when the dynamic authentication method is selected.
  • apiKey (required) — Your AdBlast API key, dynamically provided when using the dynamic authentication method.
  • project_id (required) — The ID of the project under which the environment exists.
  • environmentId (required) — The ID of the environment to be updated.
  • name — The new name for the environment.
  • prompt — A description prompt for the environment.
  • requestOptions — Optional settings for the request including batching, SSL, proxy, and timeout.

Output shape

a single record indicating the success or failure of the update operation.

Returned data includes the updated environment details if successful; otherwise, an error message.

Examples

Example 1: Updating an environment with a new name and optional properties while using predefined credentials.

Set 'authenticationMethod' to 'credentials'. Fill 'project_id' and 'environmentId'. Specify 'name' and 'prompt' for updates.

Example 2: Updating environment using dynamic API key.

Set 'authenticationMethod' to 'dynamic'. Supply 'url' and 'apiKey'. Include 'project_id' and 'environmentId'. Update 'name' and 'prompt' as needed.

Discussion