Create support snippet

POST/workspaces/{organizationId}/support/snippets

Authorization

AuthorizationBearer token · headerrequired

Workspace API key (Authorization: Bearer <key>). Issue keys under Settings → Developer or POST /workspaces/{organizationId}/tokens.

Path parameters

organizationIdstringrequired

Request body

application/json

namestringrequired

textContentstringrequired

markdownContentstring

Responses

201

Snippet created

snippetobjectrequired

Show properties

idstringrequired

organizationIdstringrequired

namestringrequired

textContentstringrequired

markdownContentstring | nullrequired

createdAtstring<date-time>required

updatedAtstring<date-time>required

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

organizationIdpath*

Bodyapplication/json

namestring*textContentstring*markdownContentstring

Request

curl -X POST 'https://pile.nyc/workspaces/string/support/snippets' \
  -H 'Authorization: Bearer YOUR_TOKEN' \
  -H 'Accept: application/json' \
  -H 'Content-Type: application/json' \
  -d '{
  "name": "string",
  "textContent": "string",
  "markdownContent": "string"
}'

const response = await fetch("https://pile.nyc/workspaces/string/support/snippets", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Accept": "application/json",
    "Content-Type": "application/json"
  },
  body: "{\n  \"name\": \"string\",\n  \"textContent\": \"string\",\n  \"markdownContent\": \"string\"\n}"
});

import requests

response = requests.post(
    "https://pile.nyc/workspaces/string/support/snippets",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Accept": "application/json",
        "Content-Type": "application/json"
    },
    data="{\n  \"name\": \"string\",\n  \"textContent\": \"string\",\n  \"markdownContent\": \"string\"\n}",
)

Response

{
  "snippet": {
    "id": "string",
    "organizationId": "string",
    "name": "string",
    "textContent": "string",
    "markdownContent": "string",
    "createdAt": "2019-08-24T14:15:22Z",
    "updatedAt": "2019-08-24T14:15:22Z"
  }
}