HUhubspot
Basic

Retrieve prompt

Changed on

Retrieve detailed information about a specific prompt, including its visibility settings, using the prompt's unique identifier. This endpoint is useful for obtaining insights into a prompt's configuration and its associated data within the specified date range.

get/marketing/aeo/2027-03-beta/prompts/{promptId}

Request

  • Base URL
    https://api.hubapi.com
  • URL
    https://api.hubapi.com/marketing/aeo/2027-03-beta/prompts/{promptId}
  • Auth
    • OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: marketing.aeo.write
    • or OAuth 2
      Authorization code: https://app.hubspot.com/oauth/authorize
      Token URL: https://api.hubapi.com/oauth/v1/token scopes: marketing.aeo.read

Path parameters

promptIdstring required

Query parameters

endDatestring
startDatestring

Response

successful operation

aiAssistantsstring[] required

An array of AI assistants associated with the prompt.

businessUnitIdstring required

The identifier for the business unit associated with the prompt.

buyingJourneyPhasestring

The phase of the buying journey that the prompt is associated with.

createdAtstring date-time required

The date and time when the prompt was created, in ISO 8601 format.

groupIdsstring[] required
icpIdsstring[] required
idstring required

The unique identifier for the prompt.

languagestring

The language in which the prompt is written.

productIdsstring[] required
promptstring required

The text of the prompt.

visibilitystring

An object representing the visibility settings of the prompt.

Changes

  • 2027-03-beta3e1835f1fe1dRevision changes
    • info

      the security scope marketing.aeo.write was added to the endpoint's security scheme oauth2

    • info

      the security scope marketing.aeo.read was removed from the endpoint's security scheme oauth2

  • 2027-03-beta53bae9def894Revision changes
    • info

      the security scope marketing.aeo.write was added to the endpoint's security scheme oauth2

    • info

      the security scope marketing.aeo.read was removed from the endpoint's security scheme oauth2