StateSet API Docs

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

POST

api

macros

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

Request body

CreateMacroRequest

boolean

string

required

The text sent to the customer. {{slot}} marks a merge field.

string

required

Unique within the org. Re-posting a name REPLACES that macro.

string

object

string[]

string

object

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
`201`	Macro created or replaced
`400`	Invalid macro (empty body, unbalanced merge fields)
`401`	Unauthorized — missing or invalid credentials
`403`	Forbidden — the key/token lacks the required scope
`429`	Rate limited — see Retry-After / X-RateLimit-Reset

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

​Request body

​Response

​Status codes

Request body

Response

Status codes