Headers

• Authorization string

  Bearer token used for authorization

  Minimum length is 1.

• X-Correlation-Id string

  Unique identifier to allow referencing a particular transaction or event chain

  Minimum length is 1.

• Accept-Language string

  Returns the requested resources translated according to the passed languages (see translatable resources)

  Minimum length is 1.

Path parameters

• id string Required

  Primary identifier of the requested resource

  Minimum length is 1.

Responses

• 200 application/json

  Successful operation

  Hide response attributes Show response attributes object

  • data object Required
    Hide data attributes Show data attributes object

    • id string Required

      Minimum length is 1.

    • enabledForInternalUse boolean Required
    • enabledForCustomerUse boolean Required
    • order integer Required

      Minimum value is 0.

    • externalId string | null

      Minimum length is 1, maximum length is 255.

    • name object | null Required
      Hide name attributes Show name attributes object | null

      • language string Required

        Values are da, de, el, en, es, fr, ja, nl, no, or pl.

      • value string Required
      • Additional properties are NOT allowed
    • description object | null Required
      Hide description attributes Show description attributes object | null

      • language string Required

        Values are da, de, el, en, es, fr, ja, nl, no, or pl.

      • value string Required
      • Additional properties are NOT allowed
    • instructions object | null Required
      Hide instructions attributes Show instructions attributes object | null

      • language string Required

        Values are da, de, el, en, es, fr, ja, nl, no, or pl.

      • value string Required
      • Additional properties are NOT allowed
    • subjectGroup object Required
      Hide subjectGroup attributes Show subjectGroup attributes object

      • id string Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • cancellationByAgentForm object | null
      Hide cancellationByAgentForm attributes Show cancellationByAgentForm attributes object | null

      • id string Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • cancellationByCustomerForm object | null
      Hide cancellationByCustomerForm attributes Show cancellationByCustomerForm attributes object | null

      • id string Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • completionByAgentForm object | null
      Hide completionByAgentForm attributes Show completionByAgentForm attributes object | null

      • id string Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • questionnaireForm object | null
      Hide questionnaireForm attributes Show questionnaireForm attributes object | null

      • id string Required

        Minimum length is 1.

      • Additional properties are NOT allowed
    • createdAt string(date-time) Required

      Minimum length is 1.

    • updatedAt string(date-time) Required

      Minimum length is 1.

    • deletedAt string(date-time) | null Required

      Minimum length is 1.

    • Additional properties are NOT allowed
    • translations object Required
      Hide translations attributes Show translations attributes object

      • name array[object] Required

        At least 1 element.

        Hide name attributes Show name attributes object

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required

          Minimum length is 1.

        • Additional properties are NOT allowed
      • description array[object]

        At least 0 elements.

        Hide description attributes Show description attributes object

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required

          Minimum length is 1.

        • Additional properties are NOT allowed
      • instructions array[object]

        At least 0 elements.

        Hide instructions attributes Show instructions attributes object

        • language string Required

          Values are da, de, el, en, es, fr, ja, nl, no, or pl.

        • value string Required

          Minimum length is 1.

        • Additional properties are NOT allowed
      • Additional properties are NOT allowed
  • Additional properties are NOT allowed
• 404 application/json

  Resource not found

  Hide response attribute Show response attribute object

  • errors array[object] Required

    At least 1 element.

    Hide errors attributes Show errors attributes object

    • message string Required

      Minimum length is 1.

    • code string Required

      Minimum length is 1.

    • type string Required

      Minimum length is 1.

    • statusCode string Required

      Minimum length is 1.