POST /accounts/{account_id}/cloudforce-one/v2/brand-protection/letter/generate

Generate a takedown letter from a template. Returns V4 JSON for text format or a PDF binary for pdf format.

Servers

Path parameters

Name Type Required Description
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
format String No

Valid values:

  • "pdf"
  • "text"

Default value: "text"

noticeParams Object No
noticeParams.queryId Integer No
noticeParams.domain String Yes
noticeParams.status String No

Valid values:

  • "sent"
  • "resolved"
  • "expired"
  • "draft"

Default value: "sent"

templateId String Yes
createNotice Boolean No

Default value: false

fields Object Yes
fields.registrarEmail String No
fields.resolutionByDate String No
fields.senderName String No
fields.trademarkNumber String No
fields.domain String No
fields.registrar String No
fields.senderEmail String No
fields.trademarkOwner String No
fields.jurisdiction String No
fields.senderCompany String No
fields.trademarkName String No
fields.generationDate String No
fields.senderTitle String No
fields.registrantEmail String No
fields.discoveryDate String No

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.