Get a single template by ID

GET

/notifications/{notificationId}/{channel}/templates/{templateId}

const url = 'https://api.pingram.io/notifications/example/example/templates/example';
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url https://api.pingram.io/notifications/example/example/templates/example \
  --header 'Authorization: Bearer <token>'

Authorizations

Parameters

Path Parameters

notificationId

required

string

Notification ID

channel

required

string

Channel type

templateId

required

string

Template ID

Responses

200

Successful response

application/json

Any of:

object
Array

Any of:

object

envId

required

string

notificationId

required

string

templateId

required

string

channel

required

string

Allowed values: EMAIL INAPP_WEB SMS CALL PUSH WEB_PUSH SLACK

default

required

boolean

isDefaultFor

object

key

additional properties

boolean

html

required

string

previewText

string

internal

required

string

subject

required

string

senderName

required

string

senderEmail

required

string

object

envId

required

string

notificationId

required

string

templateId

required

string

channel

required

string

Allowed values: EMAIL INAPP_WEB SMS CALL PUSH WEB_PUSH SLACK

default

required

boolean

isDefaultFor

object

key

additional properties

boolean

text

required

string

blocks

Array<object>

object

key

additional properties

username

string

icon

string

thread_ts

string

reply_broadcast

boolean

parse

string

Allowed values: full none

link_names

boolean

mrkdwn

boolean

unfurl_links

boolean

unfurl_media

boolean

metadata

Slack message metadata with optional work object entities. Combines standard Slack message metadata fields with an array of entity objects.

object

entities

An array of work object entities.

Array<object>

object

entity_type

required

Entity type (e.g., ‘slack#/entities/task’, ‘slack#/entities/file’).

string

entity_payload

required

Schema for the given entity type.

object

key

additional properties

external_ref

required

Reference used to identify an entity within the developer’s system.

object

required

string

type

string

url

required

URL used to identify an entity within the developer’s system.

string

app_unfurl_url

The exact URL posted in the source message. Required in metadata passed to chat.unfurl.

string

event_type

A human readable alphanumeric string representing your application’s metadata event.

string

event_payload

A free-form object containing whatever data your application wishes to attach to messages.

object

key

additional properties

Array

Any of:

object

envId

required

string

notificationId

required

string

templateId

required

string

channel

required

string

Allowed values: EMAIL INAPP_WEB SMS CALL PUSH WEB_PUSH SLACK

default

required

boolean

isDefaultFor

object

key

additional properties

boolean

html

required

string

previewText

string

internal

required

string

subject

required

string

senderName

required

string

senderEmail

required

string

object

envId

required

string

notificationId

required

string

templateId

required

string

channel

required

string

Allowed values: EMAIL INAPP_WEB SMS CALL PUSH WEB_PUSH SLACK

default

required

boolean

isDefaultFor

object

key

additional properties

boolean

text

required

string

blocks

Array<object>

object

key

additional properties

username

string

icon

string

thread_ts

string

reply_broadcast

boolean

parse

string

Allowed values: full none

link_names

boolean

mrkdwn

boolean

unfurl_links

boolean

unfurl_media

boolean

metadata

Slack message metadata with optional work object entities. Combines standard Slack message metadata fields with an array of entity objects.

object

entities

An array of work object entities.

Array<object>

object

entity_type

required

Entity type (e.g., ‘slack#/entities/task’, ‘slack#/entities/file’).

string

entity_payload

required

Schema for the given entity type.

object

key

additional properties

external_ref

required

Reference used to identify an entity within the developer’s system.

object

required

string

type

string

url

required

URL used to identify an entity within the developer’s system.

string

app_unfurl_url

The exact URL posted in the source message. Required in metadata passed to chat.unfurl.

string

event_type

A human readable alphanumeric string representing your application’s metadata event.

string

event_payload

A free-form object containing whatever data your application wishes to attach to messages.

object

key

additional properties

Example

{
  "channel": "EMAIL"
}

400

Bad Request - validation errors, invalid input

application/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example ^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

401

Unauthorized

402

Payment Required - usage limits exceeded

application/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example ^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

500

Internal Server Error

502

Bad Gateway - provider error

application/json

Standard error response for API errors.

object

trackingId

required

Unique tracking ID for the request.

string

error

required

Structured error details for API error responses.

object

code

required

Machine-readable error code.

string

message

required

Human-readable error message.

string

fix

Actionable hint for fixing the error.

string

Example ^generated

{
  "trackingId": "example",
  "error": {
    "code": "example",
    "message": "example",
    "fix": "example"
  }
}

Get a single template by ID

Authorizations

Parameters

Path Parameters

Responses

200

Example

400

Example generated

401

402

Example generated

500

502

Example generated

Example ^generated

Example ^generated

Example ^generated