Skip to main content

Developer Console - AI Assistant, Environment Switcher, Managing Apps and API Credentials & OpenAPI 1.11.0

This release adds two new Developer Console guides — AI Assistant and Environment Switcher — and significantly updates Managing Applications and API Credentials with expanded apps and key management workflows, refreshed UI graphics, and end-to-end key lifecycle documentation. This release also syncs the Candescent DI API reference to specification version 1.11.0. Customer Campaigns — Audience and Promotions Suite subcategories document SFTP file registration, upload job monitoring, and renamed user list endpoints. Documents and Preferences — Electronic Statements and the Error Codes Reference are updated to align with contract messages.

You can view the OpenAPI specification in the public GitHub repository candescent-dev/openapi.

What's New​

AI Assistant Guide​

  • Ask AI — Natural-language help for APIs, SDKs, integrations, and Developer Console workflows.
  • Access — Open from the floating Ask AI button or the AI Assistant URL.
  • Page-aware help — Answers can use your current Developer Console screen context.
  • Conversations — Suggested prompts, Recent History, pin/delete, and toolbar actions.
  • Permissions — Full, limited, and no-access states, plus steps to request access from an administrator.
  • Troubleshooting — Opening the assistant, sending messages, loading history, and known limitations.

Environment Switcher Guide​

  • Environment Switcher — Header control for Sandbox, Staging, and Production.
  • Switching — Environment pill, switcher panel, confirmation banner, and header accent indicators.
  • Environments — Sandbox, Staging, and Production environments, what key expiry defaults apply, and which Sandbox Tools are available.
  • Use cases — View apps, create applications, manage keys, and access sandbox-only pages.
  • Troubleshooting — Grayed-out environments, empty app lists, missing Sandbox Tools, and redirects.

Managing Applications and API Credentials Guide Updates​

  • Apps and Key Management — Apps list, Create App wizard, and one-time credential disclosure.
  • Access keys — Table filters, sorting, unrestricted vs. restricted keys, and row lifecycle actions.
  • Key rotation — Rotation workflow with traffic monitoring and retiring the previous credential.
  • App lifecycle — Connected APIs, app deletion, permissions, troubleshooting, quick reference, and FAQ.
  • Updated graphics — Refreshed screenshots aligned to the current console UI.

Promotions Suite​

  • Promotions Suite Overview — OAuth V1 requirements, di_tid header, job status retention, and expanded error code documentation.
  • Create User List Upload Job — POST /pss/v1/fis/{fiId}/audiences/userListJobs enqueues a member ID upload and returns a jobId (replaces the prior Create User List endpoint).
  • Get User List Upload Job — GET /pss/v1/fis/{fiId}/audiences/userListJobs/{jobId} tracks job progress through Converting, Committing, Uploading, Completed, and Failed states (replaces Get User List Upload Status).
  • Error Codes Reference — Promotions Suite errors expanded with specific 400, 401, 404, 429, and 500 userMessage mappings for user list validation, authorization, malformed jobId, not-found jobs, rate limits, and server failures.

Audience​

  • Audience Overview — SFTP CSV upload workflow, file naming convention (FI<fiId>_<fileLabel>_<yyyyMMddHHmmss>.csv), scopes, required headers, and Audience error codes.
  • Create User List Metadata — POST /v1/userlists registers metadata for SFTP-uploaded user list files with CREATE, REPLACE, ADD, REMOVE, CREATE_OR_REPLACE, and CREATE_OR_ADD operations.
  • Get User List File Details — GET /v1/userlists returns processing status (viewName=fileStatus) or error report availability (viewName=fileErrorReport).
  • Error Codes Reference — Audience errors expanded from generic HTTP status messages to application codes 401, 2001, 2003, 2005, 2006, 2009, and 3000 for JWT, header, SFTP metadata, file naming, operation, and view name validation.

Electronic Statements​

  • Electronic Statements — Updated scope descriptions, prerequisites wording, and UXESTMT_* error messages aligned to the OpenAPI contract.
  • Retrieve E-Statement Account Preferences — Prerequisites section and refined request and response documentation.
  • Retrieve E-Statement Accounts Opt-In Report — Prerequisites section and updated parameter descriptions.
  • Error Codes Reference — UXESTMT_11012–UXESTMT_11020, UXESTMT_30003, UXESTMT_88888, UXESTMT_88889, UXESTMT_88891, and UXESTMT_99998 updated with contract-aligned punctuation and field quoting.

Get Started​

  1. AI Assistant — Open Ask AI, use suggested prompts, and manage conversation history.
  2. Environment Switcher — Choose Sandbox, Staging, or Production before creating apps or managing credentials.
  3. Managing Applications and API Credentials — Create apps, generate and rotate keys, and manage credentials through the full lifecycle.
  4. Audience — Register SFTP-uploaded files and monitor processing status.
  5. Promotions Suite — Upload audience lists and track upload jobs by jobId.
  6. Error Codes Reference — Updated Audience, Promotions Suite, and Electronic Statements error mappings.
  7. Candescent DI API — Updated reference (OpenAPI 1.11.0); use Try It on endpoint pages for live Stage requests.

The Candescent Developer Experience Team