--- title: Trigger a share rename --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Resource Sharing](https://developers.cloudflare.com/api/typescript/resources/resource_sharing) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Trigger a share rename client.resourceSharing.update(stringshareID, ResourceSharingUpdateParams {account\_id, name } params, RequestOptionsoptions?): [ResourceSharingUpdateResponse]() {id, account\_id, account\_name, 12 more } PUT/accounts/{account\_id}/shares/{share\_id} Updates the share’s display name and tags. This endpoint does **not** modify recipients or resources — those are managed via dedicated subresource endpoints: - **Recipients**: Use `POST /accounts/{account_id}/shares/{share_id}/recipients` to add a single recipient, `PUT /accounts/{account_id}/shares/{share_id}/recipients` to replace the full recipient list, or `DELETE /accounts/{account_id}/shares/{share_id}/recipients/{recipient_id}` to remove a recipient. - **Resources**: Use the share’s resource subresource endpoints. Updating is not immediate; an updated share object with a new status will be returned. ##### 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 shareID: string Share identifier tag. maxLength32 [Link to this property](<#(resource)%20resource_sharing%20%3E%20(method)%20update%20%3E%20(params)%20default%20%3E%20(param)%20share_id%20%3E%20(schema)>)

params: ResourceSharingUpdateParams {account\_id, name }

account\_id: string Path param: Account identifier. maxLength32 Link to this property name: string Body param: The name of the share. Link to this property

[Link to this property](<#(resource)%20resource_sharing%20%3E%20(method)%20update%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

ResourceSharingUpdateResponse {id, account\_id, account\_name, 12 more }

id: string Share identifier tag. maxLength32 Link to this property account\_id: string Account identifier. maxLength32 Link to this property account\_name: string The display name of an account. 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 name: string The name of the share. Link to this property organization\_id: string Organization identifier. maxLength32 Link to this property

status: "active"| "deleting"| "deleted"

One of the following: "active" Link to this property "deleting" Link to this property "deleted" Link to this property

Link to this property

target\_type: "account"| "organization"

One of the following: "account" Link to this property "organization" Link to this property

Link to this property associated\_recipient\_count?: number The number of recipients in the ‘associated’ state. This field is only included when requested via the ‘include\_recipient\_counts’ parameter. Link to this property associating\_recipient\_count?: number The number of recipients in the ‘associating’ state. This field is only included when requested via the ‘include\_recipient\_counts’ parameter. Link to this property disassociated\_recipient\_count?: number The number of recipients in the ‘disassociated’ state. This field is only included when requested via the ‘include\_recipient\_counts’ parameter. Link to this property disassociating\_recipient\_count?: number The number of recipients in the ‘disassociating’ state. This field is only included when requested via the ‘include\_recipient\_counts’ parameter. Link to this property

kind?: "sent"| "received"

One of the following: "sent" Link to this property "received" Link to this property

Link to this property

resources?: Array<Resource> 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. maxLength32 Link to this property created: string When the share was created. formatdate-time Link to this property meta: unknown Resource Metadata. Link to this property modified: string When the share was modified. formatdate-time Link to this property resource\_account\_id: string Account identifier. maxLength32 Link to this property resource\_id: string Share Resource identifier. maxLength32 Link to this property

resource\_type: "custom-ruleset"| "gateway-policy"| "gateway-destination-ip"| 4 more Resource Type.

One of the following: "custom-ruleset" Link to this property "gateway-policy" Link to this property "gateway-destination-ip" Link to this property "gateway-block-page-settings" Link to this property "gateway-extended-email-matching" Link to this property "idp-federation-grant" Link to this property "trust-grant" Link to this property

Link to this property resource\_version: number Resource Version. Link to this property

status: "active"| "deleting"| "deleted" Resource Status.

One of the following: "active" Link to this property "deleting" Link to this property "deleted" Link to this property

Link to this property

[Link to this property](<#(resource)%20resource_sharing%20%3E%20(model)%20resource_sharing_update_response%20%3E%20(schema)>) ### Trigger a share rename TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiEmail: process.env['CLOUDFLARE_EMAIL'], // This is the default and can be omitted apiKey: process.env['CLOUDFLARE_API_KEY'], // This is the default and can be omitted }); const resourceSharing = await client.resourceSharing.update('3fd85f74b32742f1bff64a85009dda07', { account_id: '023e105f4ecef8ad9ca31a8372d0c353', name: 'My Shared WAF Managed Rule', }); console.log(resourceSharing.id); ``` 200 example ``` { "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" } ] } } ``` ##### Returns Examples 200 example ``` { "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" } ] } } ```