---
title: Trigger a recipient addition to a share
---

[Skip to content](#_top)

[API Reference](https://developers.cloudflare.com/api/python)

[Resource Sharing](https://developers.cloudflare.com/api/python/resources/resource_sharing)

[Recipients](https://developers.cloudflare.com/api/python/resources/resource_sharing/subresources/recipients)

Copy Markdown

Open in **Claude**Open in **ChatGPT**Open in **Cursor**

---

**Copy Markdown****View as Markdown**

# Trigger a recipient addition to a share

resource\_sharing.recipients.create(strshare\_id, RecipientCreateParams\*\*kwargs) -> [RecipientCreateResponse](<https://developers.cloudflare.com/api/python/resources/resource_sharing#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)>)

POST/accounts/{account\_id}/shares/{share\_id}/recipients

Adds a single recipient to an account-targeted resource share, granting them access to the shared resources. The recipient account must belong to the same organization as the share owner.

To replace the entire recipient list in one call, use `PUT /accounts/{account_id}/shares/{share_id}/recipients` instead.

##### Security

API Email + API Key

The previous authorization scheme for interacting with the Cloudflare API, used in conjunction with a Global API key.

**Example:**`X-Auth-Email: user@example.com`

The previous authorization scheme for interacting with the Cloudflare API. When possible, use API tokens instead of Global API keys.

**Example:**`X-Auth-Key: 144c9defac04969c7bfad8efaa8ea194`

##### ParametersExpand Collapse

account\_id: str

Account identifier.

maxLength32

[Link to this property](<#(resource)%20resource_sharing.recipients%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)

share\_id: str

Share identifier tag.

maxLength32

[Link to this property](<#(resource)%20resource_sharing.recipients%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20share_id%20%3E%20(schema)>)

account\_id: str

Account identifier.

maxLength32

[Link to this property](<#(resource)%20resource_sharing.recipients%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20account_id%20%3E%20(schema)>)

organization\_id: Optional\[str]

Organization identifier.

maxLength32

[Link to this property](<#(resource)%20resource_sharing.recipients%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20organization_id%20%3E%20(schema)>)

recipient\_account\_id: Optional\[str]

The account that will receive the share.

maxLength32

[Link to this property](<#(resource)%20resource_sharing.recipients%20%3E%20(method)%20create%20%3E%20(params)%20default%20%3E%20(param)%20recipient_account_id%20%3E%20(schema)>)

##### ReturnsExpand Collapse

<details>

<summary>

class RecipientCreateResponse: …

A recipient of a share. The <code>association_status</code> field tracks the lifecycle of the shared resources in the recipient account. All recipients are returned by the list endpoint regardless of status; filter client-side if only active recipients are needed.

</summary>

id: str

Share Recipient identifier tag.

maxLength32

<a href="#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)%20%3E%20(property)%20id">Link to this property</a>

account\_id: str

Account identifier.

maxLength32

<a href="#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)%20%3E%20(property)%20account_id">Link to this property</a>

<details>

<summary>

association\_status: Literal\["associating", "associated", "disassociating", "disassociated"]

The current state of the recipient relative to the share. The <code>desired_association_status</code> (not exposed in the response) tracks the target state set by the API; the background reconciliation workflow drives <code>current_association_status</code> toward it.

- <code>associating</code> — The recipient was recently added; the workflow is pushing shared resources into the recipient account.
- <code>associated</code> — Shared resources have been successfully applied to the recipient account.
- <code>disassociating</code> — The recipient was removed (via DELETE or PUT replacement); the workflow is removing shared resources from the recipient account.
- <code>disassociated</code> — Shared resources have been removed from the recipient account. The recipient record remains in the database.

</summary>

One of the following:

"associating"

<a href="#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)%20%3E%20(property)%20association_status%20%3E%20(member)%200">Link to this property</a>

"associated"

<a href="#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)%20%3E%20(property)%20association_status%20%3E%20(member)%201">Link to this property</a>

"disassociating"

<a href="#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)%20%3E%20(property)%20association_status%20%3E%20(member)%202">Link to this property</a>

"disassociated"

<a href="#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)%20%3E%20(property)%20association_status%20%3E%20(member)%203">Link to this property</a>

</details>

<a href="#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)%20%3E%20(property)%20association_status">Link to this property</a>

created: datetime

When the share was created.

formatdate-time

<a href="#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)%20%3E%20(property)%20created">Link to this property</a>

modified: datetime

When the share was modified.

formatdate-time

<a href="#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)%20%3E%20(property)%20modified">Link to this property</a>

<details>

<summary>

resources: Optional\[List\[Resource]]

</summary>

error: str

Share Recipient error message.

<a href="#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)%20%3E%20(property)%20resources%20%3E%20(items)%20%3E%20(property)%20error">Link to this property</a>

resource\_id: str

Share Resource identifier.

maxLength32

<a href="#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)%20%3E%20(property)%20resources%20%3E%20(items)%20%3E%20(property)%20resource_id">Link to this property</a>

resource\_version: int

Resource Version.

<a href="#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)%20%3E%20(property)%20resources%20%3E%20(items)%20%3E%20(property)%20resource_version">Link to this property</a>

terminal: bool

Whether the error is terminal or will be continually retried.

<a href="#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)%20%3E%20(property)%20resources%20%3E%20(items)%20%3E%20(property)%20terminal">Link to this property</a>

</details>

<a href="#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)%20%3E%20(property)%20resources">Link to this property</a>

</details>

[Link to this property](<#(resource)%20resource_sharing.recipients%20%3E%20(model)%20recipient_create_response%20%3E%20(schema)>)

### Trigger a recipient addition to a share

Python

HTTPTypeScriptPythonGoTerraform

```
import os
from cloudflare import Cloudflare

client = Cloudflare(
    api_email=os.environ.get("CLOUDFLARE_EMAIL"),  # This is the default and can be omitted
    api_key=os.environ.get("CLOUDFLARE_API_KEY"),  # This is the default and can be omitted
)
recipient = client.resource_sharing.recipients.create(
    share_id="3fd85f74b32742f1bff64a85009dda07",
    path_account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(recipient.id)
```

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "3fd85f74b32742f1bff64a85009dda07",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "association_status": "associating",
    "created": "2023-09-21T18:56:32.624632Z",
    "modified": "2023-09-21T18:56:32.624632Z",
    "resources": [
      {
        "error": "Recipient is missing necessary entitlement",
        "resource_id": "023e105f4ecef8ad9ca31a8372d0c353",
        "resource_version": 0,
        "terminal": true
      }
    ]
  }
}
```

##### Returns Examples

200 example

```
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "3fd85f74b32742f1bff64a85009dda07",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "association_status": "associating",
    "created": "2023-09-21T18:56:32.624632Z",
    "modified": "2023-09-21T18:56:32.624632Z",
    "resources": [
      {
        "error": "Recipient is missing necessary entitlement",
        "resource_id": "023e105f4ecef8ad9ca31a8372d0c353",
        "resource_version": 0,
        "terminal": true
      }
    ]
  }
}
```