Responses

• 200

  200 Success.

  Hide response attributes Show response attributes object

  • agreement_id integer Required

    Agreement ID.

  • name string Required

    Agreement name.

  • content string Required

    Agreement content.

  • content_height string

    Agreement content height. Otherwise, null.

  • checkbox_text string Required

    Agreement checkbox text.

  • is_active boolean Required

    Agreement status.

  • is_html boolean Required
    • true - HTML. * false - plain text.
  • mode integer Required

    The agreement applied mode.

  • extension_attributes object

    ExtensionInterface class for @see \Magento\CheckoutAgreements\Api\Data\AgreementInterface

• 401

  401 Unauthorized

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace

• default

  Unexpected error

  Hide response attributes Show response attributes object

  • message string Required

    Error message

  • errors array[object]

    Error details

    Hide errors attributes Show errors attributes object

    • message string

      Error message

    • parameters array[object]

      Error parameters item

      Hide parameters attributes Show parameters attributes object

      • resources string

        ACL resource

      • fieldName string

        Missing or invalid field name

      • fieldValue string

        Incorrect field value

  • code integer

    Error code

  • parameters array[object]

    Error parameters item

    Hide parameters attributes Show parameters attributes object

    • resources string

      ACL resource

    • fieldName string

      Missing or invalid field name

    • fieldValue string

      Incorrect field value

  • trace string

    Stack trace