Skip to content
ShareOutShareOut Docs

Create a template

POST
/v1/templates
curl --request POST \
  --url https://shareout.site/v1/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "name": "example", "subject": "example", "html": "example", "text_body": "example", "artifact_id": "example", "variables": [ { "name": "example", "type": "string", "required": false, "default": "example", "description": "example" } ] }'

Authorizations

Section titled “Authorizations”

Request Bodyrequired

Section titled “Request Bodyrequired”
Media typeapplication/json
object
name
required
string
subject
required
string
html
required
string
text_body
string
artifact_id

Scope to an artifact; null = account-level.

string | null
variables
Array<object>
object
name
required

Accessed via {{data.name}}.

string
type
required
string
Allowed values: string number boolean date
required
boolean
default
description
string

Responses

Section titled “Responses”

200

Section titled “200”

Created

Media typeapplication/json
object
success
boolean
data
object
template
object
id
string
artifact_id
string | null
owner_id
string
name
string
subject
string
html
string
text_body
string
is_system
boolean
created_at
integer
updated_at
integer
Examplegenerated
{
  "success": true,
  "data": {
    "template": {
      "id": "example",
      "artifact_id": "example",
      "owner_id": "example",
      "name": "example",
      "subject": "example",
      "html": "example",
      "text_body": "example",
      "is_system": true,
      "created_at": 1,
      "updated_at": 1
    }
  }
}

400

Section titled “400”

Invalid request

Media typeapplication/json
object
success
required
boolean
error
required

Human-readable message.

string
code
required

Machine-readable error code.

string
request_id

Correlation id (also the X-Request-Id header). Quote it in support tickets.

string
reason

Finer cause under code. For UNAUTHORIZED: missing, invalid, revoked or expired.

string
hint

What to do next, in plain words.

string
suggestion
string
param

The request field at fault.

string
docs

Doc page for this error.

string
redirect_url
string
support

Present on 5xx — how to reach a human.

object
how
string
include
Array<string>
Example
{
  "success": false,
  "support": {
    "how": "POST /v1/support/tickets",
    "include": [
      "request_id"
    ]
  }
}