ApiErrorNextAction

Describes a recoverable action the client can take after receiving this error. The exact fields depend on the action type.

  • type
    Type: string
    max length:  
    5000
    required

    The type of action the client should perform.

  • metadata
    Type: object | null

    Additional action-specific metadata. Keys and values are strings so clients can safely forward them to SDK handlers or use them for follow-up requests.

    • propertyName
      Type: string
  • use_sdk
    Type: object

    Instructs the client to continue the flow through a client-side SDK.

    • sdk
      Type: string
      max length:  
      5000
      required

      The SDK capability the client should invoke.

    • metadata
      Type: object | null

      SDK-specific metadata. The keys are specific to the returned SDK action.