Map an approved WhatsApp template - Pineyard API

Map an approved WhatsApp template

curl --request POST \
  --url https://api.pineyard.ai/whatsapp/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "purpose": "<string>",
  "providerName": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({purpose: '<string>', providerName: '<string>'})
};

fetch('https://api.pineyard.ai/whatsapp/templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.pineyard.ai/whatsapp/templates"

payload = {
    "purpose": "<string>",
    "providerName": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "purpose": "<string>",
  "providerName": "<string>",
  "languageCode": "<string>",
  "category": "MARKETING",
  "headerKind": "NONE",
  "headerBindings": [
    null
  ],
  "bodyBindings": [
    null
  ],
  "buttonBindings": {},
  "bodyPreview": "<string>",
  "status": "DRAFT",
  "senderId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "components": [
    null
  ],
  "sampleValues": {},
  "rejectionReason": "<string>",
  "providerCheckedAt": "<string>",
  "submissionIsAutomatic": true,
  "requiresRuntimeContext": true,
  "headerMediaFileName": "<string>",
  "headerMediaAttached": true,
  "clicks": 123,
  "trackedLinks": 123,
  "providerCategory": "MARKETING"
}

POST

/

whatsapp

/

templates

Map an approved WhatsApp template

curl --request POST \
  --url https://api.pineyard.ai/whatsapp/templates \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "purpose": "<string>",
  "providerName": "<string>"
}
'

const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({purpose: '<string>', providerName: '<string>'})
};

fetch('https://api.pineyard.ai/whatsapp/templates', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

import requests

url = "https://api.pineyard.ai/whatsapp/templates"

payload = {
    "purpose": "<string>",
    "providerName": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

{
  "id": "<string>",
  "purpose": "<string>",
  "providerName": "<string>",
  "languageCode": "<string>",
  "category": "MARKETING",
  "headerKind": "NONE",
  "headerBindings": [
    null
  ],
  "bodyBindings": [
    null
  ],
  "buttonBindings": {},
  "bodyPreview": "<string>",
  "status": "DRAFT",
  "senderId": "<string>",
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "components": [
    null
  ],
  "sampleValues": {},
  "rejectionReason": "<string>",
  "providerCheckedAt": "<string>",
  "submissionIsAutomatic": true,
  "requiresRuntimeContext": true,
  "headerMediaFileName": "<string>",
  "headerMediaAttached": true,
  "clicks": 123,
  "trackedLinks": 123,
  "providerCategory": "MARKETING"
}

Required scope: whatsapp.edit

Authorizations

Authorization

string

header

required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Body

application/json

purpose

string

required

Required string length: 1 - 80

providerName

string

required

Required string length: 1 - 200

languageCode

string

default:en

Required string length: 2 - 12

category

enum<string>

default:UTILITY

Available options:

MARKETING,

UTILITY,

AUTHENTICATION

headerKind

enum<string>

default:NONE

Available options:

NONE,

TEXT,

IMAGE,

DOCUMENT,

VIDEO

headerBindings

object[]

Maximum array length: 24

Show child attributes

bodyBindings

object[]

Maximum array length: 24

Show child attributes

buttonBindings

object

Show child attributes

bodyPreview

string | null

Maximum string length: 4000

senderId

string | null

components

object[]

Maximum array length: 4

Option 1
Option 2
Option 3
Option 4

Show child attributes

sampleValues

object

Show child attributes

headerMediaFileName

string | null

Maximum string length: 200

Response

Created

id

string

required

purpose

string

required

providerName

string

required

languageCode

string

required

category

enum<string>

required

Available options:

MARKETING,

UTILITY,

AUTHENTICATION

headerKind

enum<string>

required

Available options:

NONE,

TEXT,

IMAGE,

DOCUMENT,

VIDEO

headerBindings

null[]

required

bodyBindings

null[]

required

buttonBindings

object

required

Show child attributes

bodyPreview

string | null

required

status

enum<string>

required

Available options:

DRAFT,

PENDING,

APPROVED,

REJECTED,

DISABLED

senderId

string | null

required

createdAt

string

required

updatedAt

string

required

components

null[]

required

sampleValues

object

required

Show child attributes

rejectionReason

string | null

required

providerCheckedAt

string | null

required

submissionIsAutomatic

boolean

required

requiresRuntimeContext

boolean

required

headerMediaFileName

string | null

required

headerMediaAttached

boolean

required

clicks

number

required

trackedLinks

number

required

providerCategory

enum<string> | null

Available options:

MARKETING,

UTILITY,

AUTHENTICATION