Link to Latest Form

Description

Application forms are replicated as they move around the Bold Penguin system. Because of this, deep links to application forms are point-in-time and may not reflect the current state of the application.

This endpoint accepts a known ID for a given application form and returns an HTTP 302 redirect to the most recent version of that form accessible from your tenant. You can include these links in your CRM, AMS, or other system of record. The consumer must have access to the Enterprise Terminal in order to view the link.

Endpoint

Staging

https://{partner-subdomain}-agent.beta.boldpenguin.com/application_forms/{application-form-id}/latest

Production

https://{partner-subdomain}-agent.boldpenguin.com/application_forms/{application-form-id}/latest

Request Path

GET /application_forms/{application-form-id}/latest

Request Parameters

URL Parameters

  • partner-subdomain
    • You will be assigned a unique partner-subdomain within the Bold Penguin system. This will remain static across all requests to your terminal.
    • Type: String
    • Required: Yes
  • application-form-id
    • Last known ID for this application form.
    • Type: GUID string (xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx)
    • Required: Yes

Response

This endpoint returns an HTTP 302 redirect to the URL of the most recent version of the application form you can access from your tenant.

Examples

Example Request

curl --request GET \
  --url https://boldpenguin-agent.beta.boldpenguin.com/application_forms/46d7a343-2b7f-46e3-9a61-a75473086923/latest \
  --header 'authorization: Bearer CKM6LKm965bghfSSPESbac39' \

Example Response

<html><body>You are being <a href="https://boldpenguin-agent.beta.boldpenguin.com/application_forms/46d7a343-2b7f-46e3-9a61-a75473086923">redirected</a>.</body></html>

If you have permission to programmatically follow this redirect, you will receive a JSON representation of the latest application form:

{
  "id": "46d7a343-2b7f-46e3-9a61-a75473086923",
  "tenant_id": "5323b917-54f9-4866-aec7-67a5f1062be1",
  "user_group_id": "ebadd1e1-1437-43b4-a3d1-cb7ef088eeba",
  "owner_id": "cfab2232-0e31-4b50-a5cb-c21dd2a0fcde",
  "parent_id": null,
  "completed_at": null,
  "locked": false,
  "taken_over": false,
  "state": "in_progress",
  "reference_id": "BGJ-BLB-L2M",
  "cable_token": "6ba693ef-8b51-48f7-83e2-b76e37c2202e",
  "redirect_url": null,
  "quote_requests_count": 0,
  "owner_is_guest": false,
  "finished_quote_requests_count": 0,
  "created_at": "2020-03-16T13:14:11.022-04:00",
  "updated_at": "2020-03-16T13:14:12.145-04:00",
  "cloned": false,
  "inactive": true,
  "global_origin_tenant_name": null,
  "features": [],
  "application_forms_question_sets": [],
  "messages": [],
  "quote_requests": []
}

Status Codes

  • 302 Redirect to latest application form
  • 401 Not authorized
  • 404 Invalid or malformed application form ID
  • 500 Internal server error

results matching ""

    No results matching ""