PIpinterest
lead_forms

Update lead forms

Changed on

This feature is currently in beta and not available to all apps, if you're interested in joining the beta, please reach out to your Pinterest account manager.

Update lead forms. Lead ads help you reach people who are actively looking for, and interested in, your goods and services. The lead form can be associated with an ad to allow people to fill out the form.

For more, see Lead ads.

patch/ad_accounts/{ad_account_id}/lead_forms

Request

Path parameters

ad_account_idstring required

Unique identifier of an ad account.

Request body

completion_messagestring nullable

A message for people who complete the form to let them know what happens next.

disclosure_languagestring nullable

Additional disclosure language to be included in the lead form.

has_accepted_termsboolean

Whether the advertiser has accepted Pinterest's terms of service for creating a lead ad.

By sending us TRUE for this parameter, you agree that (i) you will use any personal information received in compliance with the privacy policy you share with Pinterest, and (ii) you will comply with Pinterest's Lead Ad Terms. As a reminder, all advertising on Pinterest is subject to the Pinterest Advertising Services Agreement or an equivalent agreement as set forth on an IO

idstring required

The ID of this lead form

namestring nullable

Internal name of the lead form.

privacy_policy_linkstring nullable

A link to the advertiser's privacy policy. This will be included in the lead form's disclosure language.

status'DRAFT' | 'ACTIVE'

Status of the lead form

Example request

[
  {
    "completion_message": "Thank you for submitting. We will contact you soon.",
    "disclosure_language": "By entering your personal information, you agree that your data will be collected and used.",
    "name": "Lead Form 3/14/2023",
    "policy_links": [
      {
        "label": "Copyright",
        "link": "https://policy.pinterest.com/en/copyright"
      }
    ],
    "privacy_policy_link": "https://www.advertisername.com/privacy-policy",
    "questions": [
      {
        "question_type": "CUSTOM",
        "custom_question_field_type": "CHECKBOX",
        "custom_question_label": "What is your favorite animal?",
        "custom_question_options": [
          "Dog",
          "Cat",
          "Bird",
          "Turtle"
        ]
      }
    ],
    "status": "DRAFT"
  }
]

Response

The request has succeeded.

Example response

{
  "items": [
    {
      "data": {
        "completion_message": "Thank you for submitting. We will contact you soon.",
        "disclosure_language": "By entering your personal information, you agree that your data will be collected and used.",
        "name": "Lead Form 3/14/2023",
        "policy_links": [
          {
            "label": "Copyright",
            "link": "https://policy.pinterest.com/en/copyright"
          }
        ],
        "privacy_policy_link": "https://www.advertisername.com/privacy-policy",
        "questions": [
          {
            "question_type": "CUSTOM",
            "custom_question_field_type": "CHECKBOX",
            "custom_question_label": "What is your favorite animal?",
            "custom_question_options": [
              "Dog",
              "Cat",
              "Bird",
              "Turtle"
            ]
          }
        ],
        "status": "DRAFT"
      },
      "exceptions": [
        {
          "code": 2,
          "message": "Advertiser not found."
        }
      ]
    }
  ]
}

Changes

  • v5b698c180678aRevision changes
    • breaking

      added the new required request property /

    • warning

      removed subschema #1 subschema #3 from the request property allOf list

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the new optional request property /

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      added the optional property /// to the response with the status

    • info

      removed subschema #2 from the // response property allOf list for the response status

    • info

      the response property became required for the status

    • info

      the response property //// became required for the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

    • info

      added the required property /// to the response with the status

  • v589c27ed39cfdRevision changes
    • info

      endpoint added