Clone Application Form (inbound)


Note: This three-step send side API was replace with the new two-step API on 11/08/2019. It is still available, but should be considered deprecated.


Description

Copy (clone) a completed prospect record from your tenancy to the Bold Penguin tenancy within the Exchange. This completes the send side process.

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

Authentication

Authentication requires a client_id and client_secret. A unique id and secret will be provided for each environment.

Authentication is carried out through basic auth and returns an access_token that will be used as a bearer token for subsequent requests. Tokens are valid for 12 hours.

Methods

POST

Request Syntax

The body of the request contains the recipient of the application form. For Send Side integrations this is always Bold Penguin (76fe7443-2629-494c-b645-9c4d14d780e2) and is the same in all of our environments. The source tenant_id is yours and goes in the url. The application_form_id is parsed from the Create Application Form response.

{
  "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. The tenant_id is your identifier within the Bold Penguin Exchange.
    • Type: String
    • Required: Yes
  • application_form_id

    • Unique ID of the application form you wish to clone. This is parsed from the Create Application Form response.
    • Type: String
    • Required: Yes

JSON Parameters

  • application_form
    • A JSON structure referencing the recipient tenant_id of the application form (this will always be Bold Penguin).
    • Type: JSON object
    • Required: Yes

Response Syntax

{
  "id": "<string>",
  "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 Success
  • 401 Unauthorized (verify Authorization header)
  • 422 Validation failure (verify the original application form)
  • 500 Internal server error

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

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

Example Response

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

results matching ""

    No results matching ""