stet
API reference

Create a sending profile

Requires `write` (`sending_profile:manage`). `avatarUrl`, if set, must already be an absolute URL from `POST /api/sending-profiles/avatar`.

POST/api/sending-profiles
AuthorizationBearer <token>

A Stet API key (prefix bk_), created under Settings → API keys. The whole API requires the Growth plan or higher; keys are scoped read or write — composing and sending require write.

In: header

namestring
Length1 <= length <= 100
displayNamestring
Length1 <= length <= 100
description?string | null
Lengthlength <= 500
avatarUrl?string | null

Must be an absolute URL — obtain one from POST /api/sending-profiles/avatar first.

Formaturi
footerText?string | null
Lengthlength <= 500
defaultAudienceIds?array<string>
Default[]
Itemsitems <= 100

Response Body

curl -X POST "https://app.stethq.com/api/sending-profiles" \  -H "Content-Type: application/json" \  -d '{    "name": "string",    "displayName": "string"  }'
{
  "id": "string"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}
{
  "type": "http://example.com",
  "title": "string",
  "status": 0,
  "detail": "string",
  "instance": "string"
}