Skip to main content

Clone Application Form

Description​

Clone a previously created application form to the Bold Penguin tenant. This completes the process of sending a prospect to the Exchange.

You can also create and clone an application form directly to the Exchange as a single action using the send endpoint.

Note: A prospect can only be cloned to Bold Penguin once. Bold Penguin uses the prospect's phone number to ensure uniqueness.

Endpoint​

Staging​

https://partner-engine-uat.beta.boldpenguin.com/tenants/<tenant_id>/application_forms/<application_form_id>/clones

Production​

https://partner-engine.boldpenguin.com/tenants/<tenant_id>/application_forms/<application_form_id>/clones

NOTE: that the tenant_id will be different between environments.

Authentication​

This endpoint requires an access_token from the authentication endpoint in the same environment. Include it as a bearer token in an Authorization header for the request.

Authorization: Bearer <access_token>

Methods​

POST

Request Syntax​

POST /tenants/<tenant_id>/application_forms/<application_form_id>/clones

Request Payload​

The body of the request contains the recipient of the application form. To send to the Exchange this is always Bold Penguin (76fe7443-2629-494c-b645-9c4d14d780e2) and is the same in all environments. The tenant_id in the URL should be your and represents the application form source.

{
  "application_form": {
    "tenant_id": "76fe7443-2629-494c-b645-9c4d14d780e2"
  }
}

Request Parameters​

URL Parameters​

  • tenant_id
    • You will be assigned a unique tenant_id for each of our environments.
    • Type: String
    • Required: Yes
  • application_form_id
    • The unique ID of the application form to clone. You may need to get the latest form ID
    • Type: String
    • Required: Yes

JSON Parameters​

  • application_form
    • A JSON structure referencing the destination tenant_id for the application form. For Bold Penguin, the tenant_id is 76fe7443-2629-494c-b645-9c4d14d780e2.
    • Type: JSON object
    • Required: Yes

Response Syntax​

{
  "id": "<UUID>",
  "redirect_url": null
}

Response Elements​

  • id
    • The unique ID for the cloned application form in the Bold Penguin tenancy
    • Type: String
  • redirect_url
    • Not used in this context.
    • Type: null value

Status Codes​

  • 201 Created
  • 401 Unauthorized: The necessary authentication credentials are not present in the request or are incorrect.
  • 422 Validation failure (verify the original application form)

Note: A prospect can only be cloned to Bold Penguin once. Bold Penguin uses the prospect's phone number to ensure uniqueness. If it is not unique, you will receive a 422 response.

Examples​

Example Request​

curl --request POST \
  --url https://partner-engine-uat.beta.boldpenguin.com/tenants/<tenant_id>/application_forms/<application_form_id>/clones \
  --header 'Authorization: Bearer <access_token>' \
  --header "Content-Type: application/json" \
  --data '{
  "application_form": {
    "tenant_id": 76fe7443-2629-494c-b645-9c4d14d780e2
  }

Example Response​

{
  "id": "70aa7759-56e2-4a0e-bf56-0cbba320ce05",
  "redirect_url": null
}