plaid

Update a CRA servicing subscription

Changed on

/cra/servicing/subscription/update modifies an existing CRA servicing subscription. Fields left blank are unchanged; provided fields overwrite the current value. Use reset_fields to clear fields.

post/cra/servicing/subscription/update

Request

  • Base URL
    https://production.plaid.com
  • URL
    https://production.plaid.com/cra/servicing/subscription/update
  • Auth
    API key in header PLAID-CLIENT-ID and API key in header PLAID-SECRET and API key in header Plaid-Version

Request body

client_idstring

Your Plaid API client_id. The client_id is required and may be provided either in the PLAID-CLIENT-ID header or as part of a request body.

secretstring

Your Plaid API secret. The secret is required and may be provided either in the PLAID-SECRET header or as part of a request body.

subscription_idstring required

A CRA servicing subscription identifier, in the format cra-sub-<environment>-<uuid>.

webhookstring url

The URL to which the webhook should be sent. If provided, this will override the URL set in the dashboard.

reset_fieldsCraServicingSubscriptionUpdateRequestResettableField[] nullable

A list of fields to reset back to their default value. Fields named here take precedence over any value provided for the same field elsewhere in the request.

Response

OK

subscription_idstring required

A CRA servicing subscription identifier, in the format cra-sub-<environment>-<uuid>.

request_idstring required

A unique identifier for the request, which can be used for troubleshooting. This identifier, like all Plaid identifiers, is case sensitive.

Changes

  • ea443cd78f6fRevision changes
    • warning

      added the new CRA_PARTNER_INSIGHTS_ERROR enum value to the response property for the response status

    • warning

      added the new CRA_REPORT_ERROR enum value to the response property for the response status

  • e536704a333fRevision changes
    • info

      endpoint added