Skip to main content
POST
/
exclusion-phrases
Suggest exclusion phrases for a company
curl --request POST \
  --url https://api.noonum.ai/v2/exclusion-phrases \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "companyId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "inclusionReason": "<string>",
  "objective": "<string>"
}
'
{
  "phrases": [
    {
      "phrase": "<string>",
      "reason": "<string>"
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Enter 'Bearer' followed by a space and then your JWT or API Key. Example: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9... or Bearer YOUR_API_KEY_HERE

Body

application/json
​
companyId
string<uuid>
required

Company identifier (organization id) that was included in results.

​
inclusionReason
string
required

Why the company was included in the results.

​
objective
string
required

The strategy objective expressed in natural language.

Response

Suggested phrases the user can exclude

​
phrases
object[]
required
Required array length: 2 - 10 elements