> ## Documentation Index
> Fetch the complete documentation index at: https://docs.photon.codes/docs/llms.txt
> Use this file to discover all available pages before exploring further.

> ## Agent Instructions
> Use Stable documentation by default. Honor an explicit Beta request or a URL under /docs/beta/. If the requested version conflicts with the installed CLI package or API origin, clarify the target before writing integration code.
> Pages under /docs/beta/ document Beta; other product pages document Stable. Keep the CLI package, commands, API origin, and credentials within the selected version. State the documentation version in your answer.
> For MCP search, always pass version: Stable or version: Beta. Unfiltered search mixes both versions. For filesystem reads, keep Beta queries under /beta/ and exclude /beta/ from Stable queries; discover paths before reading them.
> The public docs base is https://photon.codes/docs. Convert MCP page paths to public URLs under that base, preserving /beta/ when present. Read https://photon.codes/docs/skill.md for version selection and https://photon.codes/docs/llms.txt for the version indexes.

# Rotate Voice outbound credential

> Rotate Voice outbound credential: rotateVoiceProfileOutboundCredential in the TypeScript, Python and Rust clients.

`POST /v1/projects/{id}/platforms/voice/profiles/{profileId}/outbound/rotate`

Rotates a SIP profile's outbound credential when expectedVersion matches. The profileId may identify the default or an additional profile. Normal rotation gives the previous credential one hour of grace; emergency rotation gives none. The new password is returned once and is never recoverable. Requires platforms:write bound to the path project.

<Tabs>
  <Tab title="TypeScript">
    ```typescript TypeScript theme={null}
    photon.projects.platforms.rotateVoiceProfileOutboundCredential(input: RotateVoiceProfileOutboundCredentialInput, options?: RequestOptions): Promise<RotateVoiceProfileOutboundCredentialOutput>
    ```
  </Tab>

  <Tab title="Python">
    ```python Python theme={null}
    photon.projects.platforms.rotate_voice_profile_outbound_credential(input: RotateVoiceProfileOutboundCredentialInput) -> models.RotateVoiceProfileOutboundCredentialResponse
    ```
  </Tab>

  <Tab title="Rust">
    ```rust Rust theme={null}
    client.rotate_voice_profile_outbound_credential(idempotency_key: String, id: String, profile_id: String, body: &types::RotateVoiceProfileOutboundCredentialRequest).await -> Result<ResponseValue<types::RotateVoiceProfileOutboundCredentialResponse>, Error<RotateVoiceProfileOutboundCredentialError>>
    ```
  </Tab>
</Tabs>

<RequestExample>
  ```typescript TypeScript theme={null}
  import { Photon } from "@photon-ai/api";

  const photon = new Photon({
    headers: { Authorization: `Bearer ${process.env.PHOTON_API_TOKEN}` },
  });
  const result = await photon.projects.platforms.rotateVoiceProfileOutboundCredential({
    path: {
      id: "id",
      profileId: "profileId",
    },
    headers: {
      idempotencyKey: "idempotencyKey",
    },
    body: {
      expectedVersion: 1,
      mode: "normal",
    },
  });
  ```

  ```python Python theme={null}
  import os

  from photon_api import Photon
  from photon_api.rpc_generated import RotateVoiceProfileOutboundCredentialInput

  photon = Photon(headers={"Authorization": f"Bearer {os.environ['PHOTON_API_TOKEN']}"})
  result = photon.projects.platforms.rotate_voice_profile_outbound_credential(
      RotateVoiceProfileOutboundCredentialInput.model_validate({
          "path": {
              "id": "id",
              "profileId": "profileId",
          },
          "headers": {
              "Idempotency-Key": "idempotencyKey",
          },
          "body": {
              "expectedVersion": 1,
              "mode": "normal",
          },
      })
  )
  ```

  ```rust Rust theme={null}
  use photon_ai_api::{Credential, PhotonClientBuilder, SecretString};

  let token = std::env::var("PHOTON_API_TOKEN")?;
  let client = PhotonClientBuilder::new()
      .credential("accountServiceKey", Credential::Bearer(SecretString::from(token)))
      .build()?;
  let result = client
      .rotate_voice_profile_outbound_credential(
          "idempotencyKey".to_owned(),
          "id".to_owned(),
          "profileId".to_owned(),
          &serde_json::from_value(serde_json::json!({
              "expectedVersion": 1,
              "mode": "normal",
          }))?,
      )
      .await
      .map_err(|error| format!("{error:?}"))?
      .into_inner();
  ```
</RequestExample>

<ResponseExample>
  ```json 200 theme={null}
  {
    "password": null,
    "previousPasswordValidUntil": null,
    "profileVersion": 1
  }
  ```
</ResponseExample>

## Parameters

<ParamField header="Idempotency-Key" type={"string"} required>
  Identifies one logical mutation across retries.
</ParamField>

<ParamField path="id" type={"string"} required />

<ParamField path="profileId" type={"string"} required />

## Body

<ParamField body="expectedVersion" type={"integer"} required />

<ParamField body="mode" type={"VoiceOutboundCredentialRotationMode"} required />

## Returns

**`200`** The rotated password result and next profile version. RotateVoiceProfileOutboundCredentialResponse

<ResponseField name="password" type={"string | null"} required />

<ResponseField name="previousPasswordValidUntil" type={"string (date-time) | null"} required />

<ResponseField name="profileVersion" type={"integer"} required />


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.