Update recipient

Updates the status of the specified recipient.

A recipient is a Data Exchange partner has been "whitelisted" to send and receive data with the tenant through Data Exchange.

A recipient may have an ACTIVE or INACTIVE status. Data cannot be shared with inactive recipients

🍐

Role-based Permissions

To perform this operation, a principal must belong to a group that has been assigned the appropriate role-based permissions. The table identifies the roles with permission to perform this operation.

Data Exchange UserData Exchange Admin
NOYES

To learn more about role-based permissions, see Access Controls.

Path Params
string
required

ID of share key.

string
required

ID of recipient's share key.

Body Params
string
enum
required

Status of recipient's share key. If INACTIVE, tenant cannot send or receive exchange data with recipient.

Allowed:
Responses
202

Accepted

Language
Credentials
URL
Response
Choose an example:
application/json