This documentation aims to provide all the information you need to work with our API.
To authenticate requests, include an Authorization
header with the value "Bearer {YOUR_AUTH_KEY}"
.
All authenticated endpoints are marked with a requires authentication
badge in the documentation below.
You can retrieve your token by visiting your dashboard and clicking Generate API token.
curl --request GET \
--get "https://gohodhod.com/api/v1/newsletter/profile-info" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
curl --request PATCH \
"https://gohodhod.com/api/v1/newsletter/profile-info" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"title\": \"نشرة هدهد البريدية\",
\"author\": \"عماد الدين\",
\"description\": \"Amet voluptatum quam repellat et unde maxime et.\",
\"primary_color\": \"#146ec2\",
\"slug\": \"omnis\"
}"
curl --request POST \
"https://gohodhod.com/api/v1/newsletter/profile-image" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: multipart/form-data" \
--header "Accept: application/json" \
--form "image=@/tmp/phprHaIQj"
(optional) Filters issue based on status. Can only be: "draft", "published" or "scheduled"
curl --request GET \
--get "https://gohodhod.com/api/v1/issues" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 8768,
"subject": "Error consequatur et sed nostrum.",
"number": 1,
"description": null,
"created_at": "2024-10-28T09:19:08.000000Z",
"updated_at": "2024-10-28T09:19:08.000000Z",
"published_at": "2024-10-30T09:19:08.000000Z",
"is_published": false,
"is_scheduled": true
},
{
"id": 8769,
"subject": "Ea quo laboriosam exercitationem.",
"number": 1,
"description": null,
"created_at": "2024-10-28T09:19:08.000000Z",
"updated_at": "2024-10-28T09:19:08.000000Z",
"published_at": "2024-10-28T09:19:08.000000Z",
"is_published": true,
"is_scheduled": false
}
],
"links": {
"first": "/?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "/",
"per_page": "50",
"to": 2
}
}
The ID of the issue.
curl --request GET \
--get "https://gohodhod.com/api/v1/issues/3" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 8770,
"subject": "In omnis possimus est nam suscipit laborum pariatur.",
"number": 1,
"description": null,
"html_content": "<!-- Main table -->\n<table dir=\"rtl\" margin=\"0\" border=\"0\" cellspacing=\"0\" cellpadding=\"0\" align=\"center\" width=\"100%\">\n <tbody>\n <tr>\n <td align=\"center\">\n <h1\n style=\"font-family: inherit; font-weight:bold; font-size:30px; color:#18181B; padding:0; padding-bottom: 0px; margin:0;\">\n In omnis possimus est nam suscipit laborum pariatur.\n </h1>\n </td>\n</tr>\n<tr>\n <td height=\"5\"></td>\n</tr>\n<tr>\n <td align=\"center\"\n style=\"font-family: inherit; font-size:14px; font-weight:bold; color: #13b981\">\n <span>بواسطة لجين وريدة</span>\n <span style=\"padding: 0 5px;\">•</span>\n <span>#العدد 1</span>\n <span style=\"padding: 0 5px;\">•</span>\n <a href=\"http://gohodhod.com/@hafssa.wadih.1422/issues/8770\" style=\"color: #13b981\" target=\"_blank\">\n عرض في المتصفح\n </a>\n </td>\n</tr>\n\n\n<tr>\n <td height=\"20\"></td>\n</tr>\n<tr>\n <td align=\"center\">\n <hr style=\"height: 3px; width:75px; background-color:#d4d4d8; border: 0; border-radius: 100px;\">\n </td>\n</tr>\n<tr>\n <td height=\"20\"></td>\n</tr>\n\n </tbody>\n</table>\n",
"created_at": "2024-10-28T09:19:08.000000Z",
"updated_at": "2024-10-28T09:19:08.000000Z",
"published_at": "2024-10-28T09:19:08.000000Z",
"is_published": true,
"is_scheduled": false
}
The ID of the issue.
curl --request DELETE \
"https://gohodhod.com/api/v1/issues/3" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
true
The ID of the issue.
curl --request POST \
"https://gohodhod.com/api/v1/issues/3/publish" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
true
The ID of the issue.
The date and time when the issue should be published. Should be a valid datetime string and in the future (after current datetime).
curl --request POST \
"https://gohodhod.com/api/v1/issues/3/schedule?published_at=2023-01-01+00%3A00%3A00" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
true
The ID of the issue.
curl --request POST \
"https://gohodhod.com/api/v1/issues/3/cancel-schedule" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
true
(optional) Filters subscribers based on status. Can only be: "subscribed", "unsubscribed" or "supressed"
curl --request GET \
--get "https://gohodhod.com/api/v1/subscribers" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"data": [
{
"id": 721583,
"email": "[email protected]",
"first_name": "فايزة",
"last_name": "باشا",
"source": "dashboard",
"created_at": "2024-10-28T09:19:08.000000Z",
"updated_at": "2024-10-28T09:19:08.000000Z",
"unsubscribed_at": null,
"suppressed_at": "2024-10-28 09:19:08"
},
{
"id": 721584,
"email": "[email protected]",
"first_name": "عبد الرحمن",
"last_name": "باشا",
"source": "import",
"created_at": "2024-10-28T09:19:08.000000Z",
"updated_at": "2024-10-28T09:19:08.000000Z",
"unsubscribed_at": "2024-10-28 09:19:08",
"suppressed_at": null
}
],
"links": {
"first": "/?page=1",
"last": null,
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"path": "/",
"per_page": "50",
"to": 2
}
}
curl --request POST \
"https://gohodhod.com/api/v1/subscribers" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"[email protected]\",
\"first_name\": \"nihil\",
\"last_name\": \"consequatur\",
\"source\": \"tempore\",
\"unsubscribed_at\": \"2024-10-28T09:19:08\",
\"suppressed_at\": \"2024-10-28T09:19:08\"
}"
true
The ID of the subscriber.
curl --request GET \
--get "https://gohodhod.com/api/v1/subscribers/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
{
"id": 721585,
"email": "[email protected]",
"first_name": "معالي",
"last_name": "العقل",
"source": "dashboard",
"created_at": "2024-10-28T09:19:08.000000Z",
"updated_at": "2024-10-28T09:19:08.000000Z",
"unsubscribed_at": null,
"suppressed_at": null
}
The ID of the subscriber.
curl --request PUT \
"https://gohodhod.com/api/v1/subscribers/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json" \
--data "{
\"email\": \"[email protected]\",
\"first_name\": \"et\",
\"last_name\": \"sapiente\",
\"source\": \"delectus\",
\"unsubscribed_at\": \"2024-10-28T09:19:08\",
\"suppressed_at\": \"2024-10-28T09:19:08\"
}"
true
The ID of the subscriber.
curl --request DELETE \
"https://gohodhod.com/api/v1/subscribers/1" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
true
The ID of the subscriber.
curl --request POST \
"https://gohodhod.com/api/v1/subscribers/1/unsubscribe" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
true
The ID of the subscriber.
curl --request POST \
"https://gohodhod.com/api/v1/subscribers/1/resubscribe" \
--header "Authorization: Bearer {YOUR_AUTH_KEY}" \
--header "Content-Type: application/json" \
--header "Accept: application/json"
true