## Create a new share

**post** `/accounts/{account_id}/shares`

Creates a new resource share for sharing Cloudflare resources with other accounts or organizations.

### Path Parameters

- `account_id: string`

  Account identifier.

### Body Parameters

- `name: string`

  The name of the share.

- `recipients: array of object { account_id, organization_id, recipient_account_id }`

  - `account_id: optional string`

    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`).

  - `organization_id: optional string`

    Organization identifier.

  - `recipient_account_id: optional string`

    The account that will receive the share.

- `resources: array of object { meta, resource_account_id, resource_id, resource_type }`

  - `meta: unknown`

    Resource Metadata.

  - `resource_account_id: string`

    Account identifier.

  - `resource_id: string`

    Share Resource identifier.

  - `resource_type: "custom-ruleset" or "gateway-policy" or "gateway-destination-ip" or 3 more`

    Resource Type.

    - `"custom-ruleset"`

    - `"gateway-policy"`

    - `"gateway-destination-ip"`

    - `"gateway-block-page-settings"`

    - `"gateway-extended-email-matching"`

    - `"idp-federation-grant"`

### Returns

- `errors: array of ResponseInfo`

  - `code: number`

  - `message: string`

  - `documentation_url: optional string`

  - `source: optional object { pointer }`

    - `pointer: optional string`

- `success: boolean`

  Whether the API call was successful.

- `result: optional object { id, account_id, account_name, 12 more }`

  - `id: string`

    Share identifier tag.

  - `account_id: string`

    Account identifier.

  - `account_name: string`

    The display name of an account.

  - `created: string`

    When the share was created.

  - `modified: string`

    When the share was modified.

  - `name: string`

    The name of the share.

  - `organization_id: string`

    Organization identifier.

  - `status: "active" or "deleting" or "deleted"`

    - `"active"`

    - `"deleting"`

    - `"deleted"`

  - `target_type: "account" or "organization"`

    - `"account"`

    - `"organization"`

  - `associated_recipient_count: optional number`

    The number of recipients in the 'associated' state. This field is only included when requested via the 'include_recipient_counts' parameter.

  - `associating_recipient_count: optional number`

    The number of recipients in the 'associating' state. This field is only included when requested via the 'include_recipient_counts' parameter.

  - `disassociated_recipient_count: optional number`

    The number of recipients in the 'disassociated' state. This field is only included when requested via the 'include_recipient_counts' parameter.

  - `disassociating_recipient_count: optional number`

    The number of recipients in the 'disassociating' state. This field is only included when requested via the 'include_recipient_counts' parameter.

  - `kind: optional "sent" or "received"`

    - `"sent"`

    - `"received"`

  - `resources: optional array of object { id, created, meta, 6 more }`

    A list of resources that are part of the share. This field is only included when requested via the 'include_resources' parameter.

    - `id: string`

      Share Resource identifier.

    - `created: string`

      When the share was created.

    - `meta: unknown`

      Resource Metadata.

    - `modified: string`

      When the share was modified.

    - `resource_account_id: string`

      Account identifier.

    - `resource_id: string`

      Share Resource identifier.

    - `resource_type: "custom-ruleset" or "gateway-policy" or "gateway-destination-ip" or 3 more`

      Resource Type.

      - `"custom-ruleset"`

      - `"gateway-policy"`

      - `"gateway-destination-ip"`

      - `"gateway-block-page-settings"`

      - `"gateway-extended-email-matching"`

      - `"idp-federation-grant"`

    - `resource_version: number`

      Resource Version.

    - `status: "active" or "deleting" or "deleted"`

      Resource Status.

      - `"active"`

      - `"deleting"`

      - `"deleted"`

### Example

```http
curl https://api.cloudflare.com/client/v4/accounts/$ACCOUNT_ID/shares \
    -H 'Content-Type: application/json' \
    -H "X-Auth-Email: $CLOUDFLARE_EMAIL" \
    -H "X-Auth-Key: $CLOUDFLARE_API_KEY" \
    -d '{
          "name": "My Shared WAF Managed Rule",
          "recipients": [
            {}
          ],
          "resources": [
            {
              "meta": {},
              "resource_account_id": "023e105f4ecef8ad9ca31a8372d0c353",
              "resource_id": "023e105f4ecef8ad9ca31a8372d0c353",
              "resource_type": "custom-ruleset"
            }
          ]
        }'
```

#### Response

```json
{
  "errors": [
    {
      "code": 1000,
      "message": "message",
      "documentation_url": "documentation_url",
      "source": {
        "pointer": "pointer"
      }
    }
  ],
  "success": true,
  "result": {
    "id": "3fd85f74b32742f1bff64a85009dda07",
    "account_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "account_name": "Account A",
    "created": "2023-09-21T18:56:32.624632Z",
    "modified": "2023-09-21T18:56:32.624632Z",
    "name": "My Shared WAF Managed Rule",
    "organization_id": "023e105f4ecef8ad9ca31a8372d0c353",
    "status": "active",
    "target_type": "account",
    "associated_recipient_count": 10,
    "associating_recipient_count": 1,
    "disassociated_recipient_count": 0,
    "disassociating_recipient_count": 0,
    "kind": "sent",
    "resources": [
      {
        "id": "023e105f4ecef8ad9ca31a8372d0c353",
        "created": "2023-09-21T18:56:32.624632Z",
        "meta": {},
        "modified": "2023-09-21T18:56:32.624632Z",
        "resource_account_id": "023e105f4ecef8ad9ca31a8372d0c353",
        "resource_id": "023e105f4ecef8ad9ca31a8372d0c353",
        "resource_type": "custom-ruleset",
        "resource_version": 0,
        "status": "active"
      }
    ]
  }
}
```