> For the complete documentation index, see [llms.txt](https://developers.incidents.cloud.solarwinds.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/sdks/incidentscommunicationcards.md).

# Incidents.CommunicationCards

## Overview

### Available Operations

* [create](#create) - Create Communication Card
* [delete](#delete) - Delete Communication Card
* [update](#update) - Update Communication Card

## create

Create Communication Card

### Example Usage

```python
from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.incidents.communication_cards.create(incident_id="<id>", type_="<value>", url="https://oily-injunction.info", title="<value>")

    # Handle response
    print(res)

```

### Parameters

| Parameter     | Type                                                                                                                           | Required             | Description                                                         |
| ------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------- | ------------------------------------------------------------------- |
| `incident_id` | *str*                                                                                                                          | :heavy\_check\_mark: | Required                                                            |
| `type`        | *str*                                                                                                                          | :heavy\_check\_mark: | N/A                                                                 |
| `url`         | *str*                                                                                                                          | :heavy\_check\_mark: | N/A                                                                 |
| `title`       | *str*                                                                                                                          | :heavy\_check\_mark: | N/A                                                                 |
| `retries`     | [Optional\[utils.RetryConfig\]](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/utils/retryconfig.md) | :heavy\_minus\_sign: | Configuration to override the default retry behavior of the client. |

### Response

[**models.CommunicationCardsCreateCommunicationCardResponse**](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/communicationcardscreatecommunicationcardresponse.md)

### Errors

| Error Type                      | Status Code | Content Type     |
| ------------------------------- | ----------- | ---------------- |
| errors.BadRequestError          | 400         | application/json |
| errors.UnauthorizedError        | 401         | application/json |
| errors.PaymentRequiredError     | 402         | application/json |
| errors.ForbiddenError           | 403         | application/json |
| errors.NotFoundError            | 404         | application/json |
| errors.ConflictError            | 409         | application/json |
| errors.UnprocessableEntityError | 422         | application/json |
| errors.InternalServerError      | 500         | application/json |
| errors.BadGatewayError          | 502         | application/json |
| errors.ServiceUnavailableError  | 503         | application/json |
| errors.GatewayTimeoutError      | 504         | application/json |
| errors.SDKDefaultError          | 4XX, 5XX    | \*/\*            |

## delete

Delete communication card by providing communicationCardId for incidentId mentioned in params

Requires `access_token` as a `Bearer {{token}}` in the `Authorization` header with `service-write` scope.

### Example Usage

```python
from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.incidents.communication_cards.delete(incident_id="<id>", communication_card_id="<id>")

    # Handle response
    print(res)

```

### Parameters

| Parameter               | Type                                                                                                                           | Required             | Description                                                         |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------- | ------------------------------------------------------------------- |
| `incident_id`           | *str*                                                                                                                          | :heavy\_check\_mark: | Required                                                            |
| `communication_card_id` | *str*                                                                                                                          | :heavy\_check\_mark: | N/A                                                                 |
| `retries`               | [Optional\[utils.RetryConfig\]](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/utils/retryconfig.md) | :heavy\_minus\_sign: | Configuration to override the default retry behavior of the client. |

### Response

[**models.CommunicationCardsDeleteCommunicationCardResponse**](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/communicationcardsdeletecommunicationcardresponse.md)

### Errors

| Error Type                      | Status Code | Content Type     |
| ------------------------------- | ----------- | ---------------- |
| errors.BadRequestError          | 400         | application/json |
| errors.UnauthorizedError        | 401         | application/json |
| errors.PaymentRequiredError     | 402         | application/json |
| errors.ForbiddenError           | 403         | application/json |
| errors.NotFoundError            | 404         | application/json |
| errors.ConflictError            | 409         | application/json |
| errors.UnprocessableEntityError | 422         | application/json |
| errors.InternalServerError      | 500         | application/json |
| errors.BadGatewayError          | 502         | application/json |
| errors.ServiceUnavailableError  | 503         | application/json |
| errors.GatewayTimeoutError      | 504         | application/json |
| errors.SDKDefaultError          | 4XX, 5XX    | \*/\*            |

## update

Update Communication Card

### Example Usage

```python
from squadcast import SquadcastSDK


with SquadcastSDK(
    refresh_token_auth="<YOUR_REFRESH_TOKEN_AUTH_HERE>",
) as squadcast_sdk:

    res = squadcast_sdk.incidents.communication_cards.update(incident_id="<id>", communication_card_id="<id>", title="<value>", type_="<value>", url="https://major-cantaloupe.com/")

    # Handle response
    print(res)

```

### Parameters

| Parameter               | Type                                                                                                                           | Required             | Description                                                         |
| ----------------------- | ------------------------------------------------------------------------------------------------------------------------------ | -------------------- | ------------------------------------------------------------------- |
| `incident_id`           | *str*                                                                                                                          | :heavy\_check\_mark: | Required                                                            |
| `communication_card_id` | *str*                                                                                                                          | :heavy\_check\_mark: | N/A                                                                 |
| `title`                 | *str*                                                                                                                          | :heavy\_check\_mark: | N/A                                                                 |
| `type`                  | *str*                                                                                                                          | :heavy\_check\_mark: | N/A                                                                 |
| `url`                   | *str*                                                                                                                          | :heavy\_check\_mark: | N/A                                                                 |
| `retries`               | [Optional\[utils.RetryConfig\]](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/utils/retryconfig.md) | :heavy\_minus\_sign: | Configuration to override the default retry behavior of the client. |

### Response

[**models.CommunicationCardsUpdateCommunicationCardResponse**](https://developers.incidents.cloud.solarwinds.com/python-sdk/docs/models/communicationcardsupdatecommunicationcardresponse.md)

### Errors

| Error Type                      | Status Code | Content Type     |
| ------------------------------- | ----------- | ---------------- |
| errors.BadRequestError          | 400         | application/json |
| errors.UnauthorizedError        | 401         | application/json |
| errors.PaymentRequiredError     | 402         | application/json |
| errors.ForbiddenError           | 403         | application/json |
| errors.NotFoundError            | 404         | application/json |
| errors.ConflictError            | 409         | application/json |
| errors.UnprocessableEntityError | 422         | application/json |
| errors.InternalServerError      | 500         | application/json |
| errors.BadGatewayError          | 502         | application/json |
| errors.ServiceUnavailableError  | 503         | application/json |
| errors.GatewayTimeoutError      | 504         | application/json |
| errors.SDKDefaultError          | 4XX, 5XX    | \*/\*            |
