# Activate a portal session

> For the complete machine-readable documentation index, see [llms.txt](https://apidocs.chargebee.com/llms.txt).


[Idempotency Supported](/docs/api/idempotency)

When an user is sent back to your return URL with session details, you should validate that information by calling this API. The details passed to the **return\_url** should be sent as below:

-   **auth\_session\_id** - this should be sent as part of the endpoint.
-   **auth\_session\_token** - this should be sent as value for the input parameter **token**.

**Note:** This API is not applicable for [in-app](https://www.chargebee.com/docs/v3-self-serve-portal.html) portal.

## Sample Request

#### cURL

```bash
curl  https://{site}.chargebee.com/api/v2/portal_sessions/portal___test__KyVnGlSBWm8Rw2NP/activate \
     -u {site_api_key}:\
     -d token="__test__v3rABlcM6Cvfhcu6LGIMnNmp9sTPHcuGKcu"
```

#### .NET

```dotnet
using ChargeBee.Api;
using ChargeBee.Models;

ApiConfig.Configure("{site}","{site_api_key}");
EntityResult result = PortalSession.Activate("portal___test__KyVnGlSBWm8Rw2NP")
		.Token("__test__v3rABlcM6Cvfhcu6LGIMnNmp9sTPHcuGKcu")
		.Request();

PortalSession portalSession = result.PortalSession;
```

#### Go

```go
package main
import (
    "fmt"
    "github.com/chargebee/chargebee-go/v3"
    portalsessionAction "github.com/chargebee/chargebee-go/v3/actions/portalsession"
    "github.com/chargebee/chargebee-go/v3/models/portalsession"
)
func main() {
    chargebee.Configure("{site_api_key}","{site}");
    res,err := portalsessionAction.Activate("portal___test__KyVnGlSBWm8Rw2NP", &portalsession.ActivateRequestParams{
        Token : "__test__v3rABlcM6Cvfhcu6LGIMnNmp9sTPHcuGKcu",
    }).Request()
    if err != nil {
        fmt.Println(err)
    } else {
        PortalSession := res.PortalSession
    }
}
```

#### Go

```go
package main

import (
  "fmt"
  "github.com/chargebee/chargebee-go/v4"
)

func main() {
  config := &chargebee.ClientConfig{
    SiteName: "{site}",
    ApiKey: "{site_api_key}",
  }    
  client := chargebee.NewClient(config)
  req := &chargebee.PortalSessionActivateRequest{
    Token : "__test__v3rABlcM6Cvfhcu6LGIMnNmp9sTPHcuGKcu",
}
  res, err := client.PortalSession.Activate("portal___test__KyVnGlSBWm8Rw2NP", req)
      if err != nil {
        fmt.Println(err)
    } else {
        PortalSession := res.PortalSession
    }
}
```

#### Java

```java
import com.chargebee.*;
import com.chargebee.ListResult;
import com.chargebee.models.*;
import com.chargebee.models.enums.*;
import java.io.IOException;

public class Sample {

    public static void main(String args[]) throws IOException, Exception {
        Environment.configure("{site}", "{site_api_key}");
        Result result = PortalSession.activate("portal___test__KyVnGlSBWm8Rw2NP")
            .token("__test__v3rABlcM6Cvfhcu6LGIMnNmp9sTPHcuGKcu")
            .request();

        PortalSession portalSession = result.portalSession();
    }
}
```

#### Java

```java
import com.chargebee.v4.client.ChargebeeClient;
import com.chargebee.v4.models.portalSession.PortalSession;
import com.chargebee.v4.models.portalSession.params.PortalSessionActivateParams;
import com.chargebee.v4.models.portalSession.responses.PortalSessionActivateResponse;

public class PortalSessionActivate {

    public static void main(String[] args) {
        ChargebeeClient client = ChargebeeClient.builder()
            .apiKey("{site_api_key}")
            .siteName("{site}")
            .build();

        PortalSessionActivateParams params = PortalSessionActivateParams.builder()
            .token("__test__v3rABlcM6Cvfhcu6LGIMnNmp9sTPHcuGKcu")
            .build();

        PortalSessionActivateResponse response = client
            .portalSessions()
            .activate("portal___test__KyVnGlSBWm8Rw2NP", params);

        PortalSession portalSession = response.getPortalSession();
    }
}
```

#### Node.js

```node
import Chargebee from "chargebee";

const chargebee = new Chargebee({
    site: "{site}",
    apiKey: "{site_api_key}",
});

try {
    const result = await chargebee.portalSession.activate("portal___test__KyVnGlSBWm8Rw2NP", {
        token: "__test__v3rABlcM6Cvfhcu6LGIMnNmp9sTPHcuGKcu"
    });

    console.log(result);
    const portalSession = result.portal_session;
} catch (err) {
    console.log(err);
}
```

#### PHP

```php
<?php

require __DIR__ . '/vendor/autoload.php';

use Chargebee\ChargebeeClient;

$chargebee = new ChargebeeClient(options: [
    "site" => "{site}",
    "apiKey" => "{site_api_key}",
]);
$result = $chargebee->portalSession()->activate("portal___test__KyVnGlSBWm8Rw2NP", [
    "token" => "__test__v3rABlcM6Cvfhcu6LGIMnNmp9sTPHcuGKcu"
]);
$portalSession = $result->portal_session;
```

#### Python

```python
from chargebee import Chargebee

cb_client = Chargebee(api_key="{site_api_key}", site="{site}")
response = cb_client.PortalSession.activate("portal___test__KyVnGlSBWm8Rw2NP",
    cb_client.PortalSession.ActivateParams(
        token="__test__v3rABlcM6Cvfhcu6LGIMnNmp9sTPHcuGKcu"
    )
)
portal_session = response.portal_session
```

#### Ruby

```ruby
require 'chargebee'

ChargeBee.configure(:site => "{site}",
  :api_key => "{site_api_key}")

result = ChargeBee::PortalSession.activate("portal___test__KyVnGlSBWm8Rw2NP",{
  :token => "__test__v3rABlcM6Cvfhcu6LGIMnNmp9sTPHcuGKcu"
})

portal_session = result.portal_session
```

## Sample Response

```json
{
  "portal_session": {
    "access_url": "https://yourapp.chargebeeportal.com/portal/access/__test__v3rABlcM6Cvfhcu6LGIMnNmp9sTPHcuGKcu",
    "created_at": 1517505972,
    "customer_id": "__test__KyVnHhSBWm8QH2sR",
    "expires_at": 1517506272,
    "id": "portal___test__KyVnGlSBWm8Rw2NP",
    "linked_customers": [
      {
        "customer_id": "__test__KyVnHhSBWm8QH2sR",
        "email": "duncan@user.com",
        "has_active_subscription": false,
        "has_billing_address": false,
        "has_payment_method": false,
        "object": "linked_customer"
      },
      {..}
    ],
    "login_at": 1517505972,
    "login_ipaddress": "127.0.0.1",
    "object": "portal_session",
    "redirect_url": "https://cbdemo.com:8080",
    "status": "activated",
    "token": "__test__v3rABlcM6Cvfhcu6LGIMnNmp9sTPHcuGKcu"
  }
}
```

## URL Format

**POST** https://[site].chargebee.com/api/v2/portal_sessions/{portal-session-id}/activate

## Input Parameters

- `token` (required, string, max chars=70)
  Unique pre-authenticated portal session token to access customer portal directly.

## Returns

- `portal_session` (Portal session object)
  Resource object representing portal\_session