Generate Thank You E-mail API - ApyHub

Generate Thank You E-mail API
profile picture

Artificial IntelligenceE-commerce Quick ToolsSmart Generation#ecommerce#introduction#product
job
SharpAPI
SharpAPI
verified icon
1000 atoms

About

The Personalized Thank You Email Generator API generates a detailed thank you message for customers after a purchase, excluding the title, greeting, and sender info, allowing for easy personalization of the rest of the email.
This API is perfect for e-commerce platforms looking to automate customer engagement. It ensures each customer receives a thoughtful thank you message, enhancing their shopping experience. Use cases include sending personalized thank you emails, improving customer satisfaction, and fostering customer loyalty.
Apy Jobs are long running calls which are split into two actions:
1. Submitting the job
2. Checking the status of the job and receiving the response on successful completion of the job.
Select API Endpoints
Input(s)

API Playground

API Documentation

Generate Thank You E-mail Submit Job
POST
https://api.apyhub.com/sharpapi/api/v1/ecommerce/thank_you_email

Request example

1
curl --location --request POST 'https://api.apyhub.com/sharpapi/api/v1/ecommerce/thank_you_email' \
2
--header 'apy-token: {{token}}' \
3
--header 'Content-Type: application/json' \
4
--data '{
5
    "content": "Razer Blade 16 Gaming Laptop: NVIDIA GeForce RTX 4090-13th Gen Intel 24-Core i9 HX CPU",
6
    "language": "English"
7
}'
Method: POST
Content Type: application/json
Request Body
AttributeTypeMandatoryDescription
contentStringYesProduct name and its parameters to generate the thank you Email.
languageStringNoSpecify the language of the output, defaults to English
contextStringNoAn additional flexible instructions for content processing.
max_lengthNumberNoSpecify the maximum length of email in words. eg. 100
voice_toneStringNoSpecify the voice tone of the output. It can be adjectives like funny or joyous, or even the name of a famous writer.
Sample Response
1
{
2
  "status_url": "https://api.apyhub.com/sharpapi/api/v1/ecommerce/thank_you_email/job/status/5de4887a-0dfd-49b6-8edb-9280e468c210",
3
  "job_id": "5de4887a-0dfd-49b6-8edb-9280e468c210"
4
}

HTTP Response Codes

The method may return one of the following HTTP status codes:
Status CodeDescription
202The job was submitted successfully.
401Required authentication information is either missing or not valid for the resource.
400Invalid input - if the file is invalid or corrupted
500If any unexpected error occurs while submitting the request.

Authentication

All API requests to ApyHub services need to be authenticated. Currently we support tokens or basic authentication mechanisms. You can generate and view your existing credentials from your workspace settings (on the left side of the navbar) and go to “API Keys".
Points to note:
  • Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
  • Use the apy-token as the header parameter to pass the token.
  • Use the Authorization header to send the basic authentication credentials.

Error codes

1
{
2
  "error": {
3
    "code": 105,
4
    "message": "Invalid URL"
5
  }
6
}
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.
Table of contents
AboutAPI PlaygroundAPI DocumentationAuthenticationError codesRelated Utility APIsRelated Articles