PUT /fdx/consents/{consentId}/revocation
Appends a REVOKED status record to the named consent grant
Servers
- https://production.plaid.com
- https://sandbox.plaid.com
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
consentId |
String | Yes |
Consent Grant Identifier. Uniquely identifies the consent grant |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
updatedTime |
String | No |
When the revocation was effected on the initiator's side |
initiator |
String | Yes |
Identifies the type of a party Valid values:
|
reason |
String | Yes |
Reason for lifecycle event status change Valid values:
|
otherReason |
String | No |
Additional information or description of an |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.