StateSet API Docs

curl --request PATCH \
  --url 'https://api.nsr.stateset.com/api/v1/macros/{id}' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "auto_send": true,
  "channel": "string",
  "rule_name": "string",
  "status": {
    "0": "c",
    "1": "a",
    "2": "n",
    "3": "d",
    "4": "i",
    "5": "d",
    "6": "a",
    "7": "t",
    "8": "e"
  },
  "tags": [
    "string"
  ],
  "title": "string"
}'

{
  "auto_send": true,
  "body": "string",
  "channel": "string",
  "created_at": "string",
  "id": "string",
  "name": "string",
  "org_id": "string",
  "rule_name": "string",
  "slots": [
    "string"
  ],
  "source": "string",
  "status": "candidate",
  "tags": [
    "string"
  ],
  "title": "string",
  "tool": {
    "arguments": {},
    "name": "string"
  },
  "updated_at": "string"
}

PATCH

api

macros

{id}

curl --request PATCH \
  --url 'https://api.nsr.stateset.com/api/v1/macros/{id}' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "auto_send": true,
  "channel": "string",
  "rule_name": "string",
  "status": {
    "0": "c",
    "1": "a",
    "2": "n",
    "3": "d",
    "4": "i",
    "5": "d",
    "6": "a",
    "7": "t",
    "8": "e"
  },
  "tags": [
    "string"
  ],
  "title": "string"
}'

{
  "auto_send": true,
  "body": "string",
  "channel": "string",
  "created_at": "string",
  "id": "string",
  "name": "string",
  "org_id": "string",
  "rule_name": "string",
  "slots": [
    "string"
  ],
  "source": "string",
  "status": "candidate",
  "tags": [
    "string"
  ],
  "title": "string",
  "tool": {
    "arguments": {},
    "name": "string"
  },
  "updated_at": "string"
}

Required scope: write

Path parameters

string

required

Macro id

Request body

UpdateMacroRequest

boolean

string

object

string[]

string

Response

Macro

boolean

required

string

required

string

required

string

required

string

required

Upsert key within an org, matching the rules convention.

string

required

string

The policy rule whose citation selects this macro.

string[]

required

Merge fields parsed from body at write time.

string

MacroStatus

required

string[]

string

object

Show tool

object

string

required

string

required

Status codes

Code	Meaning
`200`	Updated macro
`401`	Unauthorized — missing or invalid credentials
`403`	Forbidden — the key/token lacks the required scope
`404`	No such macro in this organization
`429`	Rate limited — see Retry-After / X-RateLimit-Reset

curl --request PATCH \
  --url 'https://api.nsr.stateset.com/api/v1/macros/{id}' \
  --header 'X-API-Key: YOUR_API_KEY' \
  --header 'Content-Type: application/json' \
  --data '{
  "auto_send": true,
  "channel": "string",
  "rule_name": "string",
  "status": {
    "0": "c",
    "1": "a",
    "2": "n",
    "3": "d",
    "4": "i",
    "5": "d",
    "6": "a",
    "7": "t",
    "8": "e"
  },
  "tags": [
    "string"
  ],
  "title": "string"
}'

{
  "auto_send": true,
  "body": "string",
  "channel": "string",
  "created_at": "string",
  "id": "string",
  "name": "string",
  "org_id": "string",
  "rule_name": "string",
  "slots": [
    "string"
  ],
  "source": "string",
  "status": "candidate",
  "tags": [
    "string"
  ],
  "title": "string",
  "tool": {
    "arguments": {},
    "name": "string"
  },
  "updated_at": "string"
}

​Path parameters

​Request body

​Response

​Status codes

Path parameters

Request body

Response

Status codes