References

Request a brand

Changed on

Asks for a brand, usually a competitor, to be added to the Sequenzy email gallery, the same as Suggest a brand in the dashboard's gallery picker. Asking again for the same domain keeps the one request (a new note replaces the old) and returns 200 with created false, so retries never duplicate. If the brand is already in the gallery, the request comes back with status available. Requires templates:write.

post/gallery/brand-requests

Request

  • Base URL
    https://api.sequenzy.com/api/v1
  • URL
    https://api.sequenzy.com/api/v1/gallery/brand-requests
  • Auth
    HTTP bearer

Request body

websitestring required

The brand's website or domain, such as competitor.com or https://competitor.com/pricing. It is reduced to the registrable domain, so www.competitor.com and competitor.com are the same request. It cannot be your own website.

notestring

Optional. What you want to see from the brand, such as its onboarding emails.

Response

Already requested; the existing request, with its note updated when one was sent

successboolean
createdboolean

False when your company had already requested this domain.

messagestring

Example response

{
  "success": true,
  "request": {
    "domain": "competitor.com"
  }
}

Changes