openapi: 3.0.3
info:
title: Rasayel REST Channels Templates API
version: v1
description: 'Rasayel REST API for WhatsApp B2B sales automation: contacts, message templates, sending messages, conversations, tags, channels, and custom properties. Derived by API Evangelist from the provider''s public Postman collection.'
contact:
name: Rasayel
url: https://rasayel.io
x-apievangelist-method: derived
x-apievangelist-source: https://rest.developers.rasayel.io/ (public Postman collection 34761025)
x-apievangelist-generated: '2026-07-20'
servers:
- url: https://api.rasayel.io/v1
security:
- basicToken: []
tags:
- name: Templates
paths:
/templates:
get:
operationId: templatesFetchTemplates
summary: Fetch Templates
tags:
- Templates
responses:
'200':
description: Fetch a Specific Channel's Templates
content:
application/json:
example:
data:
- id: 19169
uuid: 7dc69df1-0483-4eb8-9fd1-e758e55c2723
name: abandoned_18
language: en
category: MARKETING
components:
- type: BODY
text: 'Hello {{1}}, Thanks for checking out our store! We noticed that you didn''t buy the items you had collected in your cart. We''d like to offer you a {{2}} discount for the items you selected. If you''d like to claim the discount and finish shopping, select "Go to my cart". You could also talk to one of our agents.
Have a lovely day!'
- type: BUTTONS
buttons:
- type: PHONE_NUMBER
text: Call Sales
phone_number: '+4915258537843'
- type: URL
text: Go to my cart
url: https://www.rasayel.io/
active: true
state: accepted
created_at: '2022-12-21T17:52:50.876Z'
updated_at: '2023-09-21T04:31:50.732Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 16493
uuid: 9ed35f45-2e28-464c-ac2e-29a77679d792
name: abandoned_cart_1
language: en
category: MARKETING
components:
- type: BODY
text: Hello {{1}}, Looks like you have an abandoned cart in our store. We would like to offer you free delivery for your selected items. Would you like to finish your purchase?
- type: BUTTONS
buttons:
- type: QUICK_REPLY
text: Yes.
- type: QUICK_REPLY
text: No.
active: true
state: accepted
created_at: '2022-10-20T13:02:49.154Z'
updated_at: '2022-10-21T05:08:44.794Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 16498
uuid: 7c17f175-4bc8-4c8a-aab5-3a46b8e8c57b
name: abandoned_cart_2
language: en
category: MARKETING
components:
- type: BODY
text: Hello {{1}}, Thanks for checking out our store! We noticed that you did not buy the items that you had collected in your cart. We would like to offer you a {{2}} discount for the items you selected, Would you like to claim your discount and finish your shopping?
- type: BUTTONS
buttons:
- type: QUICK_REPLY
text: Yes.
- type: QUICK_REPLY
text: No.
active: true
state: accepted
created_at: '2022-10-20T13:05:07.816Z'
updated_at: '2022-10-21T03:53:46.939Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 278
uuid: 59d85961-610c-4e01-ae98-350177ce896a
name: account_update_1
language: en
category: UTILITY
components:
- type: BODY
text: 'We have just got a new update for your account details, try to go here: {{1}} to check your updated information.'
active: true
state: accepted
created_at: '2021-04-22T10:40:02.533Z'
updated_at: '2023-03-30T10:37:51.920Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 279
uuid: 6dd0818c-0e78-4e61-8df6-33b6f5abf906
name: account_update_2
language: en
category: UTILITY
components:
- type: BODY
text: 'We have just got a new update for your account details, try to go here: {{1}} to check your updated information.'
active: true
state: accepted
created_at: '2021-04-22T10:40:02.544Z'
updated_at: '2023-03-30T10:37:52.167Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 19557
uuid: 189987b3-373e-4612-a9bd-7814332dd27d
name: account_update_22
language: en_US
category: UTILITY
components:
- type: BODY
text: Hello, we would like to inform you that your account has been updated
active: true
state: accepted
created_at: '2022-12-27T10:54:56.413Z'
updated_at: '2023-03-30T23:32:50.586Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 284
uuid: 7b9ce744-9e27-4f3a-a941-c5f5e2c83cc3
name: account_update_3
language: en
category: UTILITY
components:
- type: BODY
text: 'We have just got a new update for your account details, try to go here: {{1}} to check your updated information.'
active: true
state: accepted
created_at: '2021-04-22T10:40:02.599Z'
updated_at: '2023-03-30T23:32:54.171Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 283
uuid: 0fb6ff7b-a161-4457-b5ac-c0c6f42b3e1d
name: appointment
language: en
category: UTILITY
components:
- type: BODY
text: 'Hello {{1}}, I have booked us a slot in our calendar for our initial chat for you based on our earlier conversations. Here is the appointment link: {{2}} Thank you'
active: true
state: accepted
created_at: '2021-04-22T10:40:02.588Z'
updated_at: '2023-03-30T10:37:53.918Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 453
uuid: c5ae1d49-ccbe-4f5b-abe3-205392a2205e
name: appointment_1
language: en
category: UTILITY
components:
- type: HEADER
format: TEXT
text: Welcome to our online shoe store {{1}}!
- type: BODY
text: 'Hello {{1}}, I have booked us a slot in our calendar for our initial chat for you based on our earlier conversations. Here is the appointment link: {{2}} Thank you'
- type: FOOTER
text: Thank you so much!
- type: BUTTONS
buttons:
- type: QUICK_REPLY
text: Call us
- type: QUICK_REPLY
text: Speak to a human now
active: true
state: accepted
created_at: '2021-08-02T14:40:05.693Z'
updated_at: '2023-03-30T23:32:52.167Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 33247
uuid: 314c68fb-1a1d-4fc3-b639-92dc43213861
name: appointment_change
language: en
category: UTILITY
components:
- type: BODY
text: Hey{{1}} we are sorry to let you know that appointment date has changed to {{2}} feel free to reach out to us if you wish to cancel.
active: true
state: accepted
created_at: '2023-07-28T11:27:19.139Z'
updated_at: '2023-07-29T12:37:44.920Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 16637
uuid: be1abd83-7ea0-4b3a-b674-7a7c22a74b88
name: appointment_confirm1
language: en
category: UTILITY
components:
- type: BODY
text: Dear {{1}}, Your appointment with {{2}} on {{3}} at {{4}} is confirmed. Please, arrive 10 minutes earlier and bring an identification card with you. We look forward to seeing you.
active: true
state: accepted
created_at: '2022-10-20T13:43:07.294Z'
updated_at: '2023-03-30T23:32:51.966Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 16650
uuid: 7d91ec71-9897-4da8-af2e-cb3460e159b7
name: appointment_confirm2
language: en
category: UTILITY
components:
- type: BODY
text: Dear {{1}}, You have booked an appointment with {{2}} on {{3}} at {{4}}. We look forward to seeing you.
active: true
state: accepted
created_at: '2022-10-20T13:45:46.905Z'
updated_at: '2023-03-30T10:37:48.666Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 32598
uuid: 7ef5e1cb-ea5f-41aa-b2b2-d62483eef779
name: appointment_confirmation
language: en
category: UTILITY
components:
- type: BODY
text: Hi {{1}}, this is {{2}}. We just wanted to confirm your appointment scheduled for {{3}}. Please reply 'Confirm' or 'Reschedule' as per your convenience.
active: true
state: accepted
created_at: '2023-07-18T09:32:45.854Z'
updated_at: '2023-07-18T09:32:45.854Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 16711
uuid: fffcaac0-42f4-4a83-9f65-c65079552797
name: appointment_remind
language: en
category: UTILITY
components:
- type: BODY
text: Dear {{1}}, This is a gentle reminder that you have an appointment with {{2}} on {{3}} at {{4}}. You are advised to arrive 15 minutes before your appointment. Thank you.
active: true
state: accepted
created_at: '2022-10-20T14:29:24.336Z'
updated_at: '2023-03-30T23:32:49.885Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 16737
uuid: 6d08e1bf-c71c-493c-a70e-b5d38d5564e6
name: appointment_remind1
language: en
category: UTILITY
components:
- type: BODY
text: Hello {{1}}, This is to remind you that you are seeing {{2}} on {{3}} at {{4}}. Our address is below. Have a lovely day!
active: true
state: accepted
created_at: '2022-10-20T14:33:45.155Z'
updated_at: '2023-03-30T23:32:50.079Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 34079
uuid: ed6f77ce-a4f0-4f13-97ef-7e5fe53cd98b
name: back_in_stock
language: en
category: MARKETING
components:
- type: BODY
text: 'Hi {{1}},
Great news! The product you sought, {{2}}, is back in stock. Hurry, quantities are limited, and they''re selling fast!'
- type: FOOTER
text: Thank you for shopping with us!
- type: BUTTONS
buttons:
- type: URL
text: Visit our page
url: https://www.rasayel.io/
- type: PHONE_NUMBER
text: Talk to an agent
phone_number: '+38970223377'
active: true
state: accepted
created_at: '2023-08-14T07:52:51.007Z'
updated_at: '2023-08-14T19:57:49.930Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 40327
uuid: a9c43af4-fa61-49d9-9ecf-94deff5297b2
name: business_profile_activation_es
language: es
category: UTILITY
components:
- type: HEADER
format: VIDEO
- type: BODY
text: "{{1}}, tu perfil en Google My Business ya está listo\U0001F31F\n¡Es hora de darle vida y activarlo!\n\nPara ello, solo necesitas completar la Verificación por Video\U0001F4F9\n\n*Nosotros no podemos verificarlo por ti, ya que viola los Términos y Condiciones de Google y el perfil de tu negocio sería borrado* ❌ \U0001F30E\n\n¿Cómo hacerlo?\U0001F4F2 Subirás un video directamente en Google\n¿Listo para el desafío? Sigue estos pasos (puedes verlos en el video)\n\n1️⃣Abre tu Perfil de Negocio *en tu móvil* haciendo click aquí: {{2}} \n2️⃣Presiona \\\"Verificar\\\" (o Get Verified) y sigue los pasos.\n3️⃣Comienza la grabación del video. ¡Sonríe a la cámara y muestra tu pasión empresarial!\n4️⃣Detén la grabación, y sube el video en Google para su revisión.\n\n¡Y eso es todo! Google revisará tu video y estarás más cerca de destacar en línea.⏳\n\nAquí puedes ver un ejemplo del video que Google solicita: https://www.youtube.com/watch?v=_2S01mCnjpE\n\nSi tienes alguna duda durante el proceso ponte en contacto con nosotros.\U0001F64C"
active: true
state: accepted
created_at: '2023-10-13T13:26:30.946Z'
updated_at: '2024-02-29T21:37:45.609Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 16574
uuid: ce5ea6f7-7080-4e27-9109-ca458b17c422
name: cancellation_1
language: en
category: UTILITY
components:
- type: BODY
text: Hello {{1}}, This is to confirm that your order of {{2}} has been canceled. We have not charged your credit card. Have a nice day.
active: true
state: accepted
created_at: '2022-10-20T13:21:39.601Z'
updated_at: '2023-03-30T10:37:50.668Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 16575
uuid: 26c82e0f-ee38-46ad-bc25-1ebe13b1fabd
name: cancellation_2
language: en
category: UTILITY
components:
- type: BODY
text: Hello {{1}}, we have received your cancellation request. Since you canceled {{2}} days before the delivery date, a cancellation fee of {{3}} has been incurred. Thank you and have a lovely day.
active: true
state: accepted
created_at: '2022-10-20T13:22:16.238Z'
updated_at: '2023-03-30T10:37:50.954Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 16579
uuid: c624cf5e-4fb1-4975-98f0-b8da3191bb0c
name: cancellation_3
language: en
category: UTILITY
components:
- type: BODY
text: Hello {{1}}, we received your cancellation request for the {{2}} you had ordered. We are very sorry to see that you are not interested in it anymore and will cancel it immediately. Would you like to tell us why you’d like to cancel?
- type: BUTTONS
buttons:
- type: QUICK_REPLY
text: High shipping cost
- type: QUICK_REPLY
text: High product cost
- type: QUICK_REPLY
text: Long waiting time
active: true
state: accepted
created_at: '2022-10-20T13:23:53.588Z'
updated_at: '2023-03-30T23:32:52.372Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 36193
uuid: b53b052b-51cf-4b1f-a286-8d45ef2a30e1
name: car_inquiry_followup
language: en
category: MARKETING
components:
- type: HEADER
format: IMAGE
- type: BODY
text: 'Hey there! I''m just following up in regards to the call we had earlier, attached is a photo of the car you were looking at.
Let me know if you''re still interested.'
active: true
state: accepted
created_at: '2023-09-12T10:58:31.236Z'
updated_at: '2024-02-29T21:37:46.313Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 16555
uuid: 02a6d020-55f7-4345-9310-f6404dab8ddd
name: cash_on_delivery_1
language: en
category: UTILITY
components:
- type: BODY
text: Hello {{1}}, We received your order of {{2}} with cash-on-delivery as your payment method. Please, select “Confirm” if you still want the item or “Cancel” if you’d like to cancel your order.
- type: BUTTONS
buttons:
- type: QUICK_REPLY
text: Confirm.
- type: QUICK_REPLY
text: Cancel.
active: true
state: accepted
created_at: '2022-10-20T13:15:16.734Z'
updated_at: '2023-03-30T10:37:51.145Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 16556
uuid: c54e989e-8311-448b-8fb8-6a6c0a4d808f
name: cash_on_delivery_2
language: en
category: MARKETING
components:
- type: BODY
text: Hello {{1}}, We received your order of {{2}}. If you are still interested in receiving it, please select “Confirm”. If you are not interested anymore, please select “Cancel”. Thank you and have a lovely day!
- type: BUTTONS
buttons:
- type: QUICK_REPLY
text: Confirm.
- type: QUICK_REPLY
text: Cancel.
active: true
state: accepted
created_at: '2022-10-20T13:18:18.052Z'
updated_at: '2023-03-30T10:37:50.638Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 16561
uuid: 12f77ece-8329-4a1a-ad41-45e2accd2a57
name: cash_on_delivery_3
language: en
category: UTILITY
components:
- type: BODY
text: Hello {{1}}, We received your order of {{2}} with cash on delivery as your payment method. If you are still interested in receiving it, please select “Confirm” within the next 24 hours otherwise we’d have to cancel your order 🙁 Thank you, and have a beautiful day! ✨
- type: BUTTONS
buttons:
- type: QUICK_REPLY
text: Confirm.
- type: QUICK_REPLY
text: Cancel.
active: true
state: accepted
created_at: '2022-10-20T13:20:08.882Z'
updated_at: '2023-03-30T10:37:48.211Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 272
uuid: 50c46e8d-fe87-47df-97dd-070cea21f62b
name: confirmation
language: en
category: UTILITY
components:
- type: BODY
text: Hello {{1}}, here is your account confirmation link {{2}} Thank you.
active: true
state: accepted
created_at: '2021-04-22T10:40:02.467Z'
updated_at: '2023-03-30T10:37:48.545Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 43978
uuid: 68b4e64d-bf1c-4bd5-9b0d-387164b339b5
name: contact_options
language: en_US
category: MARKETING
components:
- type: BODY
text: Hello, {{1}}. Choose one of these options to contact us.
- type: BUTTONS
buttons:
- type: QUICK_REPLY
text: Phone Call
- type: QUICK_REPLY
text: Email
- type: QUICK_REPLY
text: Here
active: true
state: accepted
created_at: '2023-11-28T11:37:44.307Z'
updated_at: '2023-11-28T15:32:47.899Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 43328
uuid: 3ea67e6c-92cf-484a-9d2e-5196258c4356
name: continue_conversation
language: en
category: MARKETING
components:
- type: BODY
text: Hey {{1}} this is {{2}} - click below to continue the conversation!
- type: BUTTONS
buttons:
- type: PHONE_NUMBER
text: Call us
phone_number: '+34800721106'
active: true
state: accepted
created_at: '2023-11-16T10:26:54.856Z'
updated_at: '2023-11-16T10:27:45.574Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 418
uuid: f0f6f5bf-849a-4695-9086-f7106a7405c9
name: continue_inquiry
language: en
category: UTILITY
components:
- type: BODY
text: Hello {{1}}, We have an update on your earlier question/inquiry, please reply with "yes" in order for us to continue our conversation with you. 🙌
active: true
state: accepted
created_at: '2021-07-04T12:40:04.424Z'
updated_at: '2023-03-30T23:32:53.179Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 36170
uuid: d59d183b-4775-4c53-b84d-ee80c90d5d4c
name: customer_assistance
language: en
category: MARKETING
components:
- type: HEADER
format: IMAGE
- type: BODY
text: Hey there, how can we help you?
active: true
state: accepted
created_at: '2023-09-12T10:09:53.702Z'
updated_at: '2024-02-29T21:37:44.367Z'
account_id: 40
app_id: 40
channel_id: 59
- id: 43310
uuid: 66b4f2dd-b18e-4e37-b3d9-7634d1c2f2f1
name: customer_follow_up
language: en
category: MARKETING
components:
- type: HEADER
format: TEXT
text: Checking in with you
- type: BODY
text: Dear {{1}} - just checking back in with you again!
- type: FOOTER
text: Thanks!
- type: BUTTONS
buttons:
- type: PHONE_NUMBER
text: Call us
phone_number: '+353894776444'
- type: URL
text: Online
url: https://rasayel.io/
active: true
state: accepted
created_at: '2023-11-16T10:20:17.211Z'
updated_at: '2023-11-16T19:27:47.156Z'
account_id: 40
app_id: 40
channel_id: 59
pagination:
total_count: 213
total_pages: 8
current_page: 1
next_page: 2
previous_page: null
first_page: true
last_page: false
post:
operationId: templatesCreateTemplate
summary: Create Template
tags:
- Templates
requestBody:
content:
application/json:
example:
name: marketing_template_1
category: MARKETING
language: en
channel_id: 10053
components:
- type: HEADER
format: TEXT
text: Checkout Our New Feature!
- type: BODY
text: Hello {{1}}, this is {{2}} from Rasayel, have you checked out our newly released feature?
- type: BUTTONS
buttons:
- type: URL
text: Check it out!
url: https://rasayel.io/{{1}}
responses:
'201':
description: Create a new Template
content:
application/json:
example:
id: 64768
uuid: 24382906-ede1-43e5-99d2-208e3c5b3c1f
name: marketing_template_1
language: en
category: MARKETING
components:
- type: HEADER
format: TEXT
text: Checkout Our New Feature!
- type: BODY
text: Hello {{1}}, this is {{2}} from Rasayel, have you checked out our newly released feature?
- type: BUTTONS
buttons:
- type: URL
text: Check it out!
url: https://rasayel.io/{{1}}
active: true
state: under_review
created_at: '2024-04-30T14:59:31.951Z'
updated_at: '2024-04-30T14:59:31.951Z'
account_id: 40
app_id: 40
channel_id: 10053
/templates/{id}:
patch:
operationId: templatesUpdateTemplate
summary: Update Template
tags:
- Templates
requestBody:
content:
application/json:
example:
components:
- type: HEADER
format: TEXT
text: New Text
- type: BODY
text: Hello this is an updated body {{1}}
responses:
'200':
description: Successful response
parameters:
- name: id
in: path
required: true
schema:
type: string
delete:
operationId: templatesDeleteTemplate
summary: Delete Template
tags:
- Templates
responses:
'200':
description: Successful response
parameters:
- name: id
in: path
required: true
schema:
type: string
get:
operationId: templatesFetchTemplate
summary: Fetch Template
tags:
- Templates
responses:
'200':
description: Fetch a single Template
content:
application/json:
example:
id: 272
uuid: 50c46e8d-fe87-47df-97dd-070cea21f62b
name: confirmation
language: en
category: UTILITY
components:
- type: BODY
text: Hello {{1}}, here is your account confirmation link {{2}} Thank you.
active: true
state: accepted
created_at: '2021-04-22T10:40:02.467Z'
updated_at: '2023-03-30T10:37:48.545Z'
account_id: 40
app_id: 40
channel_id: 59
parameters:
- name: id
in: path
required: true
schema:
type: string
components:
securitySchemes:
basicToken:
type: apiKey
in: header
name: Authorization
description: 'Basic Auth value from a Rasayel API key. Send as: Authorization: Basic {token}. API keys carry a Read or Read/Write scope. Optional X_On_Behalf_Of header impersonates a user by ID.'