Create a media collection

POST /whatsapp/collections

Create a media collection

cURL

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

201

{
  "id": "<string>",
  "tag": "<string>",
  "description": "<string>",
  "caption": "<string>",
  "itemCount": 123,
  "items": [
    {
      "id": "<string>",
      "kind": "TEXT",
      "fileName": "<string>",
      "mimeType": "<string>",
      "sizeBytes": 123,
      "caption": "<string>",
      "isUploaded": true,
      "url": "<string>",
      "sortOrder": 123,
      "createdAt": "<string>"
    }
  ],
  "createdAt": "<string>",
  "updatedAt": "<string>",
  "templateId": "<string>",
  "templateHeaderItemId": "<string>",
  "templateSendMode": "SINGLE"
}

Required scope: whatsapp.edit

Authorizations

Authorization · string · header · required

Your API key, e.g. pk_live_xxxxxxxxxxxxxxxxxxxxxxxx.

Body

application/json

tag · string · required

Required string length: 1 - 80

description · string

Maximum string length: 500

caption · string

Maximum string length: 1000

Response

201

application/json

Created

id · string · required

tag · string · required

description · string | null · required

caption · string | null · required

itemCount · number · required

items · object[] · required

Show child attributes

createdAt · string · required

updatedAt · string · required

templateId · string | null · required

templateHeaderItemId · string | null · required

templateSendMode · enum<string> · required

Available options: SINGLE, ALL