Path parameters

• requestId string Required

  The ID of the request to retrieve.

Query parameters

• expires integer

  Specify the period of validity of the url to access the uploaded documents. Should be an integer, default is 900 (15 minutes) and maximum is 3600 (1 hour).

Responses

• 200 application/json

  Specific Request.

  Hide response attributes Show response attributes object

  • _id string

    Request ID

  • campaignId string

    Campaign ID

  • createdAt string(date-time)

    Request creation date

  • portalUrl string

    URL of the portal for the main contact

  • status string

    Request status

  • dueDate string
  • privacy string
  • contact object
    Hide contact attributes Show contact attributes

    • _id string
    • email string(email)
    • firstName string
    • lastName string
    • company string
    • tag array[string]
    • custom array[object]
      Hide custom attributes Show custom attributes object

      • _id string
      • name string
      • variable string
      • value string
  • branding object
    Hide branding attributes Show branding attributes

    • useBranding boolean
    • brandingId string
  • documents array[object]
    Hide documents attributes Show documents attributes object

    • id string

      Element ID

    • itemId string

      Reference of the element in the campaign

    • name string

      Document name

    • order integer

      Element order

    • visibility boolean

      Visibility of the element on the portal

    • mandatory boolean

      Is document mandatory

    • multipleupload boolean

      Multiple upload allowed

    • extensions array[string]

      Document file extension

  • forms array[object]
    Hide forms attributes Show forms attributes object

    • id string

      Element ID

    • itemId string

      Reference of the element in the campaign

    • name string

      Form name

    • order integer

      Element order

    • visibility boolean

      Visibility of the element on the portal

    • items array[object]
      Hide items attributes Show items attributes object

      • name string

        Field name

      • type string

        Field type

      • id string

        Field ID

  • texts array[object]
    Hide texts attributes Show texts attributes object

    • id string

      Element ID

    • itemId string

      Reference of the element in the campaign

    • name string

      Text block name

    • order integer

      Element order

    • visibility boolean

      Visibility of the element on the portal

  • pages array[object]
    Hide pages attributes Show pages attributes object

    • id string

      Element ID

    • itemId string

      Reference of the element in the campaign

    • name string

      Page name

    • order integer

      Element order

    • visibility boolean

      Visibility of the element on the portal

• 400

  Bad Request -- Your request is invalid.

• 401

  Unauthorized -- Your API key is wrong.

• 403

  Forbidden -- The object requested is hidden for administrators only.

• 404

  Not Found -- The specified object could not be found.

• 429

  Too Many Requests -- You're requesting too many objects! Slow down!

• 500

  Internal Server Error -- We had a problem with our server. Try again later.

• 503

  Service Unavailable -- We're temporarily offline for maintenance. Please try again later.