Skip to content
Cloudflare API
Start here
API Reference
Resource Sharing

Recipients

List share recipients by share ID
client.resourceSharing.recipients.list(stringshareId, RecipientListParams { account_id, include_resources, page, per_page } params, RequestOptionsoptions?): V4PagePaginationArray<RecipientListResponse { id, account_id, association_status, 3 more } >
GET/accounts/{account_id}/shares/{share_id}/recipients
Get share recipient by ID
client.resourceSharing.recipients.get(stringshareId, stringrecipientId, RecipientGetParams { account_id, include_resources } params, RequestOptionsoptions?): RecipientGetResponse { id, account_id, association_status, 3 more }
GET/accounts/{account_id}/shares/{share_id}/recipients/{recipient_id}
Create a new share recipient
client.resourceSharing.recipients.create(stringshareId, RecipientCreateParams { body_account_id, organization_id } params, RequestOptionsoptions?): RecipientCreateResponse { id, account_id, association_status, 3 more }
POST/accounts/{account_id}/shares/{share_id}/recipients
Delete a share recipient
client.resourceSharing.recipients.delete(stringshareId, stringrecipientId, RecipientDeleteParams { account_id } params, RequestOptionsoptions?): RecipientDeleteResponse { id, account_id, association_status, 3 more }
DELETE/accounts/{account_id}/shares/{share_id}/recipients/{recipient_id}
ModelsExpand Collapse
RecipientListResponse { id, account_id, association_status, 3 more }
id: string

Share Recipient identifier tag.

maxLength32
account_id: string

Account identifier.

maxLength32
association_status: "associating" | "associated" | "disassociating" | "disassociated"

Share Recipient association status.

One of the following:
"associating"
"associated"
"disassociating"
"disassociated"
created: string

When the share was created.

formatdate-time
modified: string

When the share was modified.

formatdate-time
resources?: Array<Resource>
error: string

Share Recipient error message.

resource_id: string

Share Resource identifier.

maxLength32
resource_version: number

Resource Version.

terminal: boolean

Whether the error is terminal or will be continually retried.

RecipientGetResponse { id, account_id, association_status, 3 more }
id: string

Share Recipient identifier tag.

maxLength32
account_id: string

Account identifier.

maxLength32
association_status: "associating" | "associated" | "disassociating" | "disassociated"

Share Recipient association status.

One of the following:
"associating"
"associated"
"disassociating"
"disassociated"
created: string

When the share was created.

formatdate-time
modified: string

When the share was modified.

formatdate-time
resources?: Array<Resource>
error: string

Share Recipient error message.

resource_id: string

Share Resource identifier.

maxLength32
resource_version: number

Resource Version.

terminal: boolean

Whether the error is terminal or will be continually retried.

RecipientCreateResponse { id, account_id, association_status, 3 more }
id: string

Share Recipient identifier tag.

maxLength32
account_id: string

Account identifier.

maxLength32
association_status: "associating" | "associated" | "disassociating" | "disassociated"

Share Recipient association status.

One of the following:
"associating"
"associated"
"disassociating"
"disassociated"
created: string

When the share was created.

formatdate-time
modified: string

When the share was modified.

formatdate-time
resources?: Array<Resource>
error: string

Share Recipient error message.

resource_id: string

Share Resource identifier.

maxLength32
resource_version: number

Resource Version.

terminal: boolean

Whether the error is terminal or will be continually retried.

RecipientDeleteResponse { id, account_id, association_status, 3 more }
id: string

Share Recipient identifier tag.

maxLength32
account_id: string

Account identifier.

maxLength32
association_status: "associating" | "associated" | "disassociating" | "disassociated"

Share Recipient association status.

One of the following:
"associating"
"associated"
"disassociating"
"disassociated"
created: string

When the share was created.

formatdate-time
modified: string

When the share was modified.

formatdate-time
resources?: Array<Resource>
error: string

Share Recipient error message.

resource_id: string

Share Resource identifier.

maxLength32
resource_version: number

Resource Version.

terminal: boolean

Whether the error is terminal or will be continually retried.