Patch
|
|||||
|
|
||||
Patch Member via Apiary Patch Orchestration
Authorization
To use this building block you will have to grant access to at least one of the following scopes:
- View and manage the provisioning of groups on your domain
- View and manage group subscriptions on your domain
Input
This building block consumes 10 input parameters
| Name | Format | Description |
|---|---|---|
groupKey Required |
STRING |
Email or immutable ID of the group. If ID, it should match with id of group object |
memberKey Required |
STRING |
Email or immutable ID of the user. If ID, it should match with id of member object |
email |
STRING |
Email of member (Read-only) |
kind |
STRING |
Kind of resource this is |
delivery_settings |
STRING |
Delivery settings of member |
etag |
STRING |
ETag of the resource |
id |
STRING |
Unique identifier of group (Read-only) Unique identifier of member (Read-only) The unique ID of the group member. A member id can be used as a member request URI's memberKey |
type |
STRING |
Type of member (Immutable) |
status |
STRING |
Status of member (Immutable) |
role |
STRING |
Role of member |
= Parameter name
= Format
|
groupKey STRING Required Email or immutable ID of the group. If ID, it should match with id of group object |
|
memberKey STRING Required Email or immutable ID of the user. If ID, it should match with id of member object |
|
email STRING Email of member (Read-only) |
|
kind STRING Kind of resource this is |
|
delivery_settings STRING Delivery settings of member |
|
etag STRING ETag of the resource |
|
id STRING Unique identifier of group (Read-only) Unique identifier of member (Read-only) The unique ID of the group member. A member id can be used as a member request URI's memberKey |
|
type STRING Type of member (Immutable) |
|
status STRING Status of member (Immutable) |
|
role STRING Role of member |
Output
This building block provides 8 output parameters
| Name | Format | Description |
|---|---|---|
email |
STRING |
Email of member (Read-only) |
kind |
STRING |
Kind of resource this is |
delivery_settings |
STRING |
Delivery settings of member |
etag |
STRING |
ETag of the resource |
id |
STRING |
Unique identifier of group (Read-only) Unique identifier of member (Read-only) The unique ID of the group member. A member id can be used as a member request URI's memberKey |
type |
STRING |
Type of member (Immutable) |
status |
STRING |
Status of member (Immutable) |
role |
STRING |
Role of member |
= Parameter name
= Format
|
email STRING Email of member (Read-only) |
|
kind STRING Kind of resource this is |
|
delivery_settings STRING Delivery settings of member |
|
etag STRING ETag of the resource |
|
id STRING Unique identifier of group (Read-only) Unique identifier of member (Read-only) The unique ID of the group member. A member id can be used as a member request URI's memberKey |
|
type STRING Type of member (Immutable) |
|
status STRING Status of member (Immutable) |
|
role STRING Role of member |