---
title: Trigger a recipient addition to a share
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Resource Sharing](https://developers.cloudflare.com/api/resources/resource_sharing)
[Recipients](https://developers.cloudflare.com/api/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
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`
##### P ath ParametersExpand Collapse
account\_id: string
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: string
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)>)
##### Body ParametersJSONExpand Collapse
Deprecatedaccount\_id: optional string
This field has been renamed to `recipient_account_id`. Both names are accepted during the deprecation period.
Deprecated alias for `recipient_account_id`. Use `recipient_account_id` instead. The body field collided with the URL path parameter of the same name, which prevented SDK generators from distinguishing the source account (in the URL) from the recipient account (in the body). Both names will continue to be accepted until 2027-05-26 (see `x-sunset`).
maxLength32
[Link to this property](<#(resource)%20resource_sharing.recipients%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20account_id%20%3E%20(schema)>)
organization\_id: optional string
Organization identifier.
maxLength32
[Link to this property](<#(resource)%20resource_sharing.recipients%20%3E%20(method)%20create%20%3E%20(params)%200%20%3E%20(param)%20organization_id%20%3E%20(schema)>)
recipient\_account\_id: optional string
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)%200%20%3E%20(param)%20recipient_account_id%20%3E%20(schema)>)
##### ReturnsExpand Collapse
errors: array of ResponseInfo { code, message, documentation\_url, source }
code: number
minimum1000
Link to this property
message: string
Link to this property
documentation\_url: optional string
Link to this property
source: optional object {pointer }
pointer: optional string
Link to this property
Link to this property
[Link to this property](<#(resource)%20resource_sharing.recipients%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20errors>)
success: boolean
Whether the API call was successful.
[Link to this property](<#(resource)%20resource_sharing.recipients%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20success>)
result: optional object {id, account\_id, association\_status, 3 more }
A recipient of a share. The association_status 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.
id: string
Share Recipient identifier tag.
maxLength32
Link to this property
account\_id: string
Account identifier.
maxLength32
Link to this property
association\_status: "associating"or "associated"or "disassociating"or "disassociated"
The current state of the recipient relative to the share. The desired_association_status (not exposed in the response) tracks the target state set by the API; the background reconciliation workflow drives current_association_status toward it.
- associating — The recipient was recently added; the workflow is pushing shared resources into the recipient account.
- associated — Shared resources have been successfully applied to the recipient account.
- disassociating — The recipient was removed (via DELETE or PUT replacement); the workflow is removing shared resources from the recipient account.
- disassociated — Shared resources have been removed from the recipient account. The recipient record remains in the database.
One of the following:
"associating"
Link to this property
"associated"
Link to this property
"disassociating"
Link to this property
"disassociated"
Link to this property
Link to this property
created: string
When the share was created.
formatdate-time
Link to this property
modified: string
When the share was modified.
formatdate-time
Link to this property
resources: optional array of object {error, resource\_id, resource\_version, terminal }
error: string
Share Recipient error message.
Link to this property
resource\_id: string
Share Resource identifier.
maxLength32
Link to this property
resource\_version: number
Resource Version.
Link to this property
terminal: boolean
Whether the error is terminal or will be continually retried.
Link to this property
Link to this property
[Link to this property](<#(resource)%20resource_sharing.recipients%20%3E%20(method)%20create%20%3E%20(network%20schema)%20%3E%20(property)%20result>)
### Trigger a recipient addition to a share
HTTP
HTTPTypeScriptPythonGoTerraform
```
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/shares/$SHARE_ID/recipients \
-H 'Content-Type: application/json' \
-H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
-H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
-d '{
"account_id": "023e105f4ecef8ad9ca31a8372d0c353",
"organization_id": "023e105f4ecef8ad9ca31a8372d0c353",
"recipient_account_id": "023e105f4ecef8ad9ca31a8372d0c353"
}'
```
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
}
]
}
}
```