For the complete documentation index, see llms.txt. This page is also available as Markdown.

Generate API Key

Use this page to generate a new API key for your Channels Plus integration in Partner Portal.

When you regenerate a key, Partner Portal creates a new current API key and keeps the previous key active as an expiring key for up to 7 days so you have time to rotate credentials on your side without interruption.

This process changes the API key only. Your API ID stays the same.

Before you begin

  • Make sure you know where your current Channels Plus API key is configured in your application or secret store.

  • Plan to update your integration as soon as the new key is generated. The old key remains valid only until the expiry date shown in Partner Portal.

Generate or regenerate your API key

  1. Log in to Partner Portal and open the API Integration page.

  2. In the Current API Credentials section, click Regenerate API key.

  3. Review the confirmation message. Partner Portal warns that regenerating your API key will create a new key and set your current key to expire in 7 days.

  4. Click Regenerate to continue.

  5. Copy and securely store the new API key, then update your integration to use it before the old key expires.

  6. Check the expiry date shown for the old key and use it as your deadline to complete the rotation.

Figure 1: Regenerate API key confirmation dialog in Partner Portal.

What happens after regeneration

  • A new API key becomes your current key.

  • Your previous key becomes an expiring key and remains valid for 7 days so you can complete the rotation safely.

  • After the expiry period ends, the old key is no longer valid.

  • If you regenerate again while an expiring key already exists, Partner Portal replaces the current key and keeps the existing expiring key as is.

Best practices

  • Update all services and environments that use the key as soon as the new key is generated.

  • Store API keys in a secure secret manager or encrypted configuration store.

  • Do not hardcode API keys in source code or expose them in client-side applications.

  • Avoid regenerating again until you have confirmed all traffic is using the new key.

sparkles

Still have questions?

Last updated

Was this helpful?