Sign in
lead_forms

Update lead forms

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

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

Changed in 2 of the 29 revisions of this API.1128

  • v5b698c180678a1127See the full diff
    • ▲

      added the new required request property items/id

      new-required-request-property

    • ●

      removed LeadFormCommon subschema #1 subschema #3 from the items/ request property allOf list

      request-property-all-of-removed

    • ○

      added the new optional request property items/completion_message

      new-optional-request-property

    • ○

      added the new optional request property items/disclosure_language

      new-optional-request-property

    • ○

      added the new optional request property items/has_accepted_terms

      new-optional-request-property

    • ○

      added the new optional request property items/name

      new-optional-request-property

    • ○

      added the new optional request property items/policy_links

      new-optional-request-property

    • ○

      added the new optional request property items/privacy_policy_link

      new-optional-request-property

    • ○

      added the new optional request property items/questions

      new-optional-request-property

    • ○

      added the new optional request property items/status

      new-optional-request-property

    • ○

      added the non-success response with the status 401

      response-non-success-status-added

    • ○

      added the non-success response with the status 403

      response-non-success-status-added

    • ○

      added the non-success response with the status 404

      response-non-success-status-added

    • ○

      added the non-success response with the status 429

      response-non-success-status-added

    • ○

      added the optional property items/items/data/ad_account_id to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/data/created_time to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/data/disclosure_language to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/data/policy_links to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/data/status to the response with the 200 status

      response-optional-property-added

    • ○

      added the optional property items/items/data/updated_time to the response with the 200 status

      response-optional-property-added

    • ○

      removed LeadFormCommon subschema #2 from the items/items/data response property allOf list for the response status 200

      response-property-all-of-removed

    • ○

      the response property items became required for the status 200

      response-property-became-required

    • ○

      the response property items/items/exceptions/items/message became required for the status 200

      response-property-became-required

    • ○

      added the required property items/items/data/completion_message to the response with the 200 status

      response-required-property-added

    • ○

      added the required property items/items/data/has_accepted_terms to the response with the 200 status

      response-required-property-added

    • ○

      added the required property items/items/data/id to the response with the 200 status

      response-required-property-added

    • ○

      added the required property items/items/data/name to the response with the 200 status

      response-required-property-added

    • ○

      added the required property items/items/data/privacy_policy_link to the response with the 200 status

      response-required-property-added

    • ○

      added the required property items/items/data/questions to the response with the 200 status

      response-required-property-added

    This revision also has 182 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

  • v589c27ed39cfd1See the full diff
    • ○

      endpoint added

      endpoint-added

    This revision also has 4 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog