Bansafe

Acknowledge ban safe finding

Records that a named person on the team has seen this finding, optionally silences its notifications for up to 30 days, and unlocks the appeal form. It does not change the Health estimate, the restriction, or any campaign limit. Requires a signed-in organization owner, admin, or developer; an API key or token is refused with bansafe_ack_requires_dashboard_identity.

Requires a verified dashboard bearer and current organization authorization. Organization keys and project tokens are not accepted.

POST

platform

bansafe

findings

{findingId}

acknowledge

Acknowledge ban safe finding

curl --request POST \
  --url https://api.polymorfa.com/platform/bansafe/findings/{findingId}/acknowledge \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "<string>",
  "snoozeDays": 15
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({note: '<string>', snoozeDays: 15})
};

fetch('https://api.polymorfa.com/platform/bansafe/findings/{findingId}/acknowledge', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/bansafe/findings/{findingId}/acknowledge"

payload = {
    "note": "<string>",
    "snoozeDays": 15
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/bansafe/findings/{findingId}/acknowledge"

	payload := strings.NewReader("{\n  \"note\": \"<string>\",\n  \"snoozeDays\": 15\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "finding": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "<string>",
      "title": "<string>",
      "summary": "<string>",
      "fix": "<string>",
      "status": "open",
      "severity": "info",
      "occurrences": 1,
      "reopenedCount": 1,
      "evidence": {},
      "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "session": "<string>",
      "phoneNumber": "<string>",
      "firstSeenAt": "2023-11-07T05:31:56Z",
      "lastSeenAt": "2023-11-07T05:31:56Z",
      "acknowledgedAt": "2023-11-07T05:31:56Z",
      "acknowledgedBy": "<string>",
      "acknowledgementNote": "<string>",
      "snoozedUntil": "2023-11-07T05:31:56Z",
      "resolvedAt": "2023-11-07T05:31:56Z",
      "resolveReason": "clean"
    },
    "message": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Path Parameters

findingId

string<uuid>

required

Identifier for the finding.

Value constraints

Constraint	Accepted input
Format	`uuid`

Body

application/json

note

string

Specifies note for this management acknowledge ban safe finding input.

Value constraints

Constraint	Accepted input
String length	At most `500` characters

Maximum string length: 500

snoozeDays

integer

Silence this finding's notifications for this many days.

Value constraints

Constraint	Accepted input
Numeric value	`1` through `30` (inclusive)

Required range: 1 <= x <= 30

Response

Success

data

object

required

Structured data carried by this object.

Show child attributes

⌘I

Acknowledge ban safe finding

curl --request POST \
  --url https://api.polymorfa.com/platform/bansafe/findings/{findingId}/acknowledge \
  --header 'Content-Type: application/json' \
  --data '
{
  "note": "<string>",
  "snoozeDays": 15
}
'

const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({note: '<string>', snoozeDays: 15})
};

fetch('https://api.polymorfa.com/platform/bansafe/findings/{findingId}/acknowledge', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.polymorfa.com/platform/bansafe/findings/{findingId}/acknowledge"

payload = {
    "note": "<string>",
    "snoozeDays": 15
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.polymorfa.com/platform/bansafe/findings/{findingId}/acknowledge"

	payload := strings.NewReader("{\n  \"note\": \"<string>\",\n  \"snoozeDays\": 15\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

{
  "data": {
    "finding": {
      "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "key": "<string>",
      "title": "<string>",
      "summary": "<string>",
      "fix": "<string>",
      "status": "open",
      "severity": "info",
      "occurrences": 1,
      "reopenedCount": 1,
      "evidence": {},
      "sessionId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
      "session": "<string>",
      "phoneNumber": "<string>",
      "firstSeenAt": "2023-11-07T05:31:56Z",
      "lastSeenAt": "2023-11-07T05:31:56Z",
      "acknowledgedAt": "2023-11-07T05:31:56Z",
      "acknowledgedBy": "<string>",
      "acknowledgementNote": "<string>",
      "snoozedUntil": "2023-11-07T05:31:56Z",
      "resolvedAt": "2023-11-07T05:31:56Z",
      "resolveReason": "clean"
    },
    "message": "<string>"
  }
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

{
  "error": {
    "type": "invalid_request_error",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>"
  },
  "data": null,
  "docs": "<string>"
}

Overview

Messaging API

Platform API

Graph API

Webhook events

Acknowledge ban safe finding

Path Parameters

Body

Response