Notifuse

https://docs.notifuse.com
Admin
Notifuse is a modern, free and open-source self-hosted emailing platform for businesses, providing...
Tokens:466,818
Snippets:2,232
Trust Score:6.4
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Go HTTP client example for webhook delivery history

Source: https://docs.notifuse.com/api-reference/get-webhook-delivery-history

Creates an HTTP GET request with an Authorization header, sends it using the default client, and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://demo.notifuse.com/api/webhookSubscriptions.deliveries?limit=20"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Create a blog post with Go

Source: https://docs.notifuse.com/api-reference/blog/create-a-blog-post

Go example using net/http to POST to the blogPosts.create endpoint. Requires a valid Bearer token and a JSON body with category_id, slug, title, template_id, and optional SEO fields. Prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://demo.notifuse.com/api/blogPosts.create"

	payload := strings.NewReader("{\n  \"category_id\": \"7c9e6679-7425-40de-944b-e07fc1f90ae7\",\n  \"slug\": \"october-release\",\n  \"title\": \"What shipped in October\",\n  \"template_id\": \"blog_october_release\",\n  \"template_version\": 0,\n  \"excerpt\": \"A faster editor, scheduled broadcasts and a new API.\",\n  \"featured_image_url\": \"https://cdn.example.com/blog/october.png\",\n  \"authors\": [\n    {\n      \"name\": \"Jane Doe\",\n      \"avatar_url\": \"https://cdn.example.com/avatars/jane.png\"\n    }\n  ],\n  \"reading_time_minutes\": 4,\n  \"seo\": {\n    \"meta_title\": \"Release notes for October\",\n    \"meta_description\": \"Everything that shipped this month.\",\n    \"og_title\": \"<string>\",\n    \"og_description\": \"<string>\",\n    \"og_image\": \"https://cdn.example.com/og/october.png\",\n    \"canonical_url\": \"https://blog.example.com/product/october-release\",\n    \"keywords\": [\n      \"release\",\n      \"changelog\"\n    ],\n    \"meta_robots\": \"index,follow\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

```

--------------------------------

### 200 response example for GET /api/blogPosts.get

Source: https://docs.notifuse.com/api-reference/blog/get-a-blog-post

Example 200 response body for a successful GET /api/blogPosts.get request. Contains the post object with id, category_id, slug, settings (including SEO fields), and timestamps. The response is returned as application/json.

```json
{
  "post": {
    "id": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
    "category_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "slug": "october-release",
    "settings": {
      "title": "What shipped in October",
      "template": {
        "template_id": "blog_october_release",
        "template_version": 3
      },
      "reading_time_minutes": 4,
      "excerpt": "A faster editor, scheduled broadcasts and a new API.",
      "featured_image_url": "https://cdn.example.com/blog/october.png",
      "authors": [
        {
          "name": "Jane Doe",
          "avatar_url": "https://cdn.example.com/avatars/jane.png"
        }
      ],
      "seo": {
        "meta_title": "Release notes for October",
        "meta_description": "Everything that shipped this month.",
        "og_title": "<string>",
        "og_description": "<string>",
        "og_image": "https://cdn.example.com/og/october.png",
        "canonical_url": "https://blog.example.com/product/october-release",
        "keywords": [
          "release",
          "changelog"
        ],
        "meta_robots": "index,follow"
      }
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "published_at": "2026-10-01T09:00:00Z"
  }
}
```

--------------------------------

### GET /api/blogPosts.list

Source: https://docs.notifuse.com/api-reference/blog/list-blog-posts

This snippet documents the GET /api/blogPosts.list endpoint, including its query parameters, request example, and response schema.

```APIDOC
## GET /api/blogPosts.list

### Description
Retrieves a paginated list of blog posts, optionally filtered by status.

### Method
GET

### Endpoint
`https://demo.notifuse.com/api/blogPosts.list`

### Parameters
#### Query Parameters
- **status** (string) - Optional - Filter posts by status. Example: `all`.
- **page** (integer) - Optional - Page number for pagination. Example: `1`.
- **limit** (integer) - Optional - Number of posts per page. Example: `50`.

### Request Example
```
curl --request GET \
  --url 'https://demo.notifuse.com/api/blogPosts.list?status=all&page=1&limit=50' \
  --header 'Authorization: Bearer <token>'
```

### Response
#### Success Response (200)
- **posts** (array) - List of blog posts.
  - **id** (string) - Unique identifier of the post.
  - **category_id** (string) - Identifier of the category.
  - **slug** (string) - URL slug of the post.
  - **settings** (object) - Post settings.
    - **title** (string) - Title of the post.
    - **template** (object) - Template information.
      - **template_id** (string) - Template identifier.
      - **template_version** (integer) - Template version.
    - **reading_time_minutes** (integer) - Estimated reading time.
    - **excerpt** (string) - Short excerpt.
    - **featured_image_url** (string) - URL of the featured image.
    - **authors** (array) - List of authors.
      - **name** (string) - Author name.
      - **avatar_url** (string) - Author avatar URL.
    - **seo** (object) - SEO metadata.
      - **meta_title** (string) - Meta title.
      - **meta_description** (string) - Meta description.
      - **og_title** (string) - Open Graph title.
      - **og_description** (string) - Open Graph description.
      - **og_image** (string) - Open Graph image URL.
      - **canonical_url** (string) - Canonical URL.
      - **keywords** (array) - SEO keywords.
      - **meta_robots** (string) - Meta robots directive.
  - **created_at** (string) - Creation timestamp.
  - **updated_at** (string) - Last update timestamp.
  - **published_at** (string) - Publication timestamp.
- **total_count** (integer) - Total number of posts matching the query.

#### Response Example
```json
{
  "posts": [
    {
      "id": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
      "category_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
      "slug": "october-release",
      "settings": {
        "title": "What shipped in October",
        "template": {
          "template_id": "blog_october_release",
          "template_version": 3
        },
        "reading_time_minutes": 4,
        "excerpt": "A faster editor, scheduled broadcasts and a new API.",
        "featured_image_url": "https://cdn.example.com/blog/october.png",
        "authors": [
          {
            "name": "Jane Doe",
            "avatar_url": "https://cdn.example.com/avatars/jane.png"
          }
        ],
        "seo": {
          "meta_title": "Release notes for October",
          "meta_description": "Everything that shipped this month.",
          "og_title": "<string>",
          "og_description": "<string>",
          "og_image": "https://cdn.example.com/og/october.png",
          "canonical_url": "https://blog.example.com/product/october-release",
          "keywords": [
            "release",
            "changelog"
          ],
          "meta_robots": "index,follow"
        }
      },
      "created_at": "2023-11-07T05:31:56Z",
      "updated_at": "2023-11-07T05:31:56Z",
      "published_at": "2026-10-01T09:00:00Z"
    }
  ],
  "total_count": 128
}
```
```

--------------------------------

### Go: List blog posts

Source: https://docs.notifuse.com/api-reference/blog/list-blog-posts

Go example using net/http to fetch blog posts. Replace <token> with your API token. Prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://demo.notifuse.com/api/blogPosts.list?status=all&page=1&limit=50"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### Go: Create a blog theme version

Source: https://docs.notifuse.com/api-reference/blog/create-a-blog-theme-version

Uses net/http to POST the theme files and notes to the blogThemes.create endpoint. Requires an Authorization bearer token.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://demo.notifuse.com/api/blogThemes.create"

	payload := strings.NewReader("{\n  \"files\": {\n    \"home.liquid\": \"<string>\",\n    \"category.liquid\": \"<string>\",\n    \"post.liquid\": \"<string>\",\n    \"header.liquid\": \"<string>\",\n    \"footer.liquid\": \"<string>\",\n    \"shared.liquid\": \"<string>\",\n    \"styles.css\": \"<string>\",\n    \"scripts.js\": \"<string>\"\n  },\n  \"notes\": \"Darker header, larger body text.\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### GET /api/auditLogs.list

Source: https://docs.notifuse.com/api-reference/audit-logs/list-audit-logs

Documentation for the GET /api/auditLogs.list endpoint, including parameters, request example, response schema, and error codes.

```APIDOC
## GET /api/auditLogs.list

### Description
Retrieves a paginated list of audit log entries for a workspace or deployment. Supports filtering by various criteria such as actions, categories, actor, outcome, and time range.

### Method
GET

### Endpoint
https://demo.notifuse.com/api/auditLogs.list

### Parameters
#### Query Parameters
- **scope** (enum<string>) - Optional, default: `workspace` - Available options: `workspace`, `deployment`
- **workspace_id** (string) - Required in workspace scope; optional narrowing in deployment scope.
- **actions** (string) - Optional - Comma-separated action names, e.g. templates.update,lists.create.
- **categories** (string) - Optional - Comma-separated categories.
- **actor_id** (string) - Optional
- **actor_email** (string) - Optional - Substring match, case-insensitive.
- **actor_type** (enum<string>) - Optional - Available options: `user`, `api_key`, `system`, `anonymous`
- **outcome** (enum<string>) - Optional - Available options: `success`, `failure`, `denied`
- **target_type** (string) - Optional
- **target_id** (string) - Optional
- **ip_address** (string) - Optional
- **from** (string<date-time>) - Optional - Only entries at or after this instant (RFC3339). A malformed value is a 400.
- **to** (string<date-time>) - Optional
- **cursor** (string) - Optional - The next_cursor of the previous page.
- **limit** (integer) - Optional, default: 50 - Clamped to 100. Required range: `x <= 100`

### Request Example
```
GET https://demo.notifuse.com/api/auditLogs.list?scope=workspace&limit=50
Authorization: Bearer <token>
```

### Response
#### Success Response (200)
- **logs** (object[]) - Array of audit log entries. Each entry contains: id, occurred_at, workspace_id, action, category, outcome, status_code, actor_type, actor_id, actor_email, actor_name, actor_role, auth_method, target_type, target_id, target_name, ip_address, user_agent, request_id, changes, metadata.
- **next_cursor** (string) - Present when has_more is true; pass it back as cursor.
- **has_more** (boolean) - Indicates if more pages are available.

#### Response Example
```
{
  "logs": [
    {
      "id": "8b8dd285f6874c17b5edcb39ef3e0b8b",
      "occurred_at": "2023-11-07T05:31:56Z",
      "workspace_id": "ws_1234567890",
      "action": "workspaces.inviteMember",
      "category": "members",
      "outcome": "success",
      "status_code": 200,
      "actor_type": "user",
      "actor_id": "<string>",
      "actor_email": "<string>",
      "actor_name": "<string>",
      "actor_role": "owner",
      "auth_method": "session",
      "target_type": "invitation",
      "target_id": "<string>",
      "target_name": "bob@example.com",
      "ip_address": "203.0.113.9",
      "user_agent": "<string>",
      "request_id": "<string>",
      "changes": {},
      "metadata": {}
    }
  ],
  "next_cursor": "<string>",
  "has_more": true
}
```

#### Error Responses
- **400** - Bad Request - Invalid parameters or malformed date.
- **403** - Forbidden - Authentication or authorization failure.

#### Error Response Example
```
{
  "error": "<string>"
}
```

### Authorizations
- **Authorization** (string, header, required) - API token for authentication.
```

--------------------------------

### Create a blog category with Net::HTTP (Ruby)

Source: https://docs.notifuse.com/api-reference/blog/create-a-blog-category

Ruby example using Net::HTTP to POST to the blogCategories.create endpoint. Uses SSL and sets the Authorization and Content-Type headers. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://demo.notifuse.com/api/blogCategories.create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"name\": \"Product\",\n  \"slug\": \"product\",\n  \"description\": \"Release notes and product announcements.\",\n  \"seo\": {\n    \"meta_title\": \"Release notes for October\",\n    \"meta_description\": \"Everything that shipped this month.\",\n    \"og_title\": \"<string>\",\n    \"og_description\": \"<string>\",\n    \"og_image\": \"https://cdn.example.com/og/october.png\",\n    \"canonical_url\": \"https://blog.example.com/product/october-release\",\n    \"keywords\": [\n      \"release\",\n      \"changelog\"\n    ],\n    \"meta_robots\": \"index,follow\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

--------------------------------

### GET /api/blogPosts.get

Source: https://docs.notifuse.com/api-reference/blog/get-a-blog-post

Complete API documentation for the GET /api/blogPosts.get endpoint, including parameters, authorization, request example, and response schemas.

```APIDOC
## GET /api/blogPosts.get

### Description
Retrieves a blog post by `id` or by `slug`. When both are given, `id` wins. Drafts are returned too. Requires the blog read permission.

### Method
GET

### Endpoint
https://demo.notifuse.com/api/blogPosts.get

### Parameters
#### Query Parameters
- **workspace_id** (string) - Required - The ID of the workspace
- **id** (string) - Optional - The post ID. Either `id` or `slug` is required.
- **slug** (string) - Optional - The post slug. Either `id` or `slug` is required. Post slugs are unique across the workspace, so the slug alone identifies the post.
- **category_slug** (string) - Optional - With `slug`, only match the post if it is in this category — the lookup a `/{category_slug}/{post_slug}` URL maps to.

### Authorizations
- **Authorization** (string, header) - Required - API token for authentication

### Request Example
```
curl --request GET \
  --url https://demo.notifuse.com/api/blogPosts.get \
  --header 'Authorization: Bearer <token>'
```

### Response
#### Success Response (200)
- **post** (object) - Required - The post

#### Response Example
```
{
  "post": {
    "id": "1b4e28ba-2fa1-11d2-883f-0016d3cca427",
    "category_id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "slug": "october-release",
    "settings": {
      "title": "What shipped in October",
      "template": {
        "template_id": "blog_october_release",
        "template_version": 3
      },
      "reading_time_minutes": 4,
      "excerpt": "A faster editor, scheduled broadcasts and a new API.",
      "featured_image_url": "https://cdn.example.com/blog/october.png",
      "authors": [
        {
          "name": "Jane Doe",
          "avatar_url": "https://cdn.example.com/avatars/jane.png"
        }
      ],
      "seo": {
        "meta_title": "Release notes for October",
        "meta_description": "Everything that shipped this month.",
        "og_title": "<string>",
        "og_description": "<string>",
        "og_image": "https://cdn.example.com/og/october.png",
        "canonical_url": "https://blog.example.com/product/october-release",
        "keywords": [
          "release",
          "changelog"
        ],
        "meta_robots": "index,follow"
      }
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z",
    "published_at": "2026-10-01T09:00:00Z"
  }
}
```

#### Error Responses
- **400** - Bad Request - e.g., `{"error": "either id or slug is required"}`
- **401** - Unauthorized - e.g., `{"error": "<string>"}`
- **403** - Forbidden - e.g., `{"error": "Insufficient permissions: read access to blog required", "resource": "blog", "permission": "read"}`
- **500** - Internal Server Error - e.g., `{"error": "Failed to get post"}`
```

--------------------------------

### Java: Create a blog theme version

Source: https://docs.notifuse.com/api-reference/blog/create-a-blog-theme-version

Uses Unirest to POST the theme files and notes to the blogThemes.create endpoint. Requires an Authorization bearer token.

```java
HttpResponse<String> response = Unirest.post("https://demo.notifuse.com/api/blogThemes.create")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"files\": {\n    \"home.liquid\": \"<string>\",\n    \"category.liquid\": \"<string>\",\n    \"post.liquid\": \"<string>\",\n    \"header.liquid\": \"<string>\",\n    \"footer.liquid\": \"<string>\",\n    \"shared.liquid\": \"<string>\",\n    \"styles.css\": \"<string>\",\n    \"scripts.js\": \"<string>\"\n  },\n  \"notes\": \"Darker header, larger body text.\"\n}")
  .asString();
```

--------------------------------

### Python request to get a blog category

Source: https://docs.notifuse.com/api-reference/blog/get-a-blog-category

Uses the requests library to perform a GET request. Requires the requests package to be installed.

```python
import requests

url = "https://demo.notifuse.com/api/blogCategories.get"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Go example to resume a broadcast

Source: https://docs.notifuse.com/api-reference/resume-a-broadcast

Uses net/http to send a POST request with the JSON payload. Reads and prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://demo.notifuse.com/api/broadcasts.resume"

	payload := strings.NewReader("{\n  \"workspace_id\": \"ws_1234567890\",\n  \"id\": \"broadcast_12345\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### 404 Response for Get a broadcast

Source: https://docs.notifuse.com/api-reference/get-a-broadcast

Example 404 response indicating the broadcast was not found.

```json
{
  "error": "Broadcast not found"
}
```

--------------------------------

### Get a contact by external ID - HTTP requests

Source: https://docs.notifuse.com/api-reference/get-a-contact-by-external-id

Send a GET request to the contacts.getByExternalID endpoint. All examples use the same endpoint and require an Authorization header with a bearer token.

```bash
curl --request GET \
  --url https://demo.notifuse.com/api/contacts.getByExternalID \
  --header 'Authorization: Bearer <token>'
```

```python
import requests

url = "https://demo.notifuse.com/api/contacts.getByExternalID"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://demo.notifuse.com/api/contacts.getByExternalID', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://demo.notifuse.com/api/contacts.getByExternalID",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://demo.notifuse.com/api/contacts.getByExternalID"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.get("https://demo.notifuse.com/api/contacts.getByExternalID")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://demo.notifuse.com/api/contacts.getByExternalID")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Create blog theme version with Ruby Net::HTTP

Source: https://docs.notifuse.com/api-reference/blog/create-a-blog-theme-version

Ruby example using Net::HTTP to POST to the blogThemes.create endpoint. Requires a valid Bearer token and a JSON body with the files map and optional notes.

```ruby
require 'uri'
require 'net/http'

url = URI("https://demo.notifuse.com/api/blogThemes.create")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"files\": {\n    \"home.liquid\": \"<string>\",\n    \"category.liquid\": \"<string>\",\n    \"post.liquid\": \"<string>\",\n    \"header.liquid\": \"<string>\",\n    \"footer.liquid\": \"<string>\",\n    \"shared.liquid\": \"<string>\",\n    \"styles.css\": \"<string>\",\n    \"scripts.js\": \"<string>\"\n  },\n  \"notes\": \"Darker header, larger body text.\"\n}"

response = http.request(request)
puts response.read_body
```

--------------------------------

### GET /api/contacts.list

Source: https://docs.notifuse.com/api-reference/list-contacts-with-filtering-and-pagination

This snippet documents the GET /api/contacts.list endpoint, which retrieves a list of contacts with optional filtering and pagination. It includes the request example, query parameters, and the response structure.

```APIDOC
## GET /api/contacts.list

### Description
Retrieves a list of contacts with optional filtering and pagination. The endpoint supports a `limit` query parameter to control the number of contacts returned per page.

### Method
GET

### Endpoint
`https://demo.notifuse.com/api/contacts.list`

### Parameters
#### Query Parameters
- **limit** (integer) - Optional - The maximum number of contacts to return. Example: `20`.

### Request Example
```
curl --request GET \
  --url 'https://demo.notifuse.com/api/contacts.list?limit=20' \
  --header 'Authorization: Bearer <token>'
```

### Response
#### Success Response (200)
- **contacts** (array) - List of contact objects.
- **next_cursor** (string) - Cursor for the next page of results.

#### Response Example
```json
{
  "contacts": [
    {
      "email": "user@example.com",
      "external_id": "user_12345",
      "timezone": "America/New_York",
      "language": "en-US",
      "first_name": "John",
      "last_name": "Doe",
      "full_name": "John Doe",
      "phone": "+15551234567",
      "address_line_1": "123 Main St",
      "address_line_2": "Apt 4B",
      "country": "US",
      "postcode": "10001",
      "state": "NY",
      "job_title": "Software Engineer",
      "custom_string_1": "Premium tier",
      "custom_string_2": "<string>",
      "custom_string_3": "<string>",
      "custom_string_4": "<string>",
      "custom_string_5": "<string>",
      "custom_number_1": 42,
      "custom_number_2": 123,
      "custom_number_3": 123,
      "custom_number_4": 123,
      "custom_number_5": 123,
      "custom_datetime_1": "2023-06-01T09:00:00Z",
      "custom_datetime_2": "2023-11-07T05:31:56Z",
      "custom_datetime_3": "2023-11-07T05:31:56Z",
      "custom_datetime_4": "2023-11-07T05:31:56Z",
      "custom_datetime_5": "2023-11-07T05:31:56Z",
      "custom_json_1": {
        "preferences": {
          "theme": "dark",
          "notifications": true
        }
      },
      "custom_json_2": "<unknown>",
      "custom_json_3": "<unknown>",
      "custom_json_4": "<unknown>",
      "custom_json_5": "<unknown>",
      "created_at": "2023-01-15T10:30:00Z",
      "updated_at": "2023-04-22T15:45:00Z",
      "contact_lists": [
        {
          "email": "user@example.com",
          "list_id": "newsletter",
          "list_name": "Newsletter",
          "status": "active",
          "created_at": "2023-01-15T10:30:00Z",
          "updated_at": "2023-01-15T10:30:00Z",
          "deleted_at": null
        }
      ],
      "contact_segments": [
        {
          "email": "user@example.com",
          "segment_id": "premium_users",
          "version": 1,
          "matched_at": "2023-01-15T10:30:00Z",
          "computed_at": "2023-01-15T10:30:00Z"
        }
      ]
    }
  ],
  "next_cursor": "MjAyMy0wMS0xNVQxMDozMDowMFp+dXNlckBleGFtcGxlLmNvbQ=="
}
```
```

--------------------------------

### Toggle webhook subscription with Go

Source: https://docs.notifuse.com/api-reference/toggle-webhook-subscription-enabled-state

Go example using the standard library to toggle a webhook subscription. Creates a POST request with the required headers and payload, then prints the response body.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://demo.notifuse.com/api/webhookSubscriptions.toggle"

	payload := strings.NewReader("{\n  \"workspace_id\": \"ws_1234567890\",\n  \"id\": \"whsub_a1b2c3d4e5f6\",\n  \"enabled\": true\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

--------------------------------

### GET /api/blogPosts.get request examples in multiple languages

Source: https://docs.notifuse.com/api-reference/blog/get-a-blog-post

Example requests for the GET /api/blogPosts.get endpoint in cURL, Python, JavaScript, PHP, Go, Java (Unirest), and Ruby. All use the Authorization header with a Bearer token and the demo base URL. The endpoint retrieves a blog post by id or slug and requires the blog read permission.

```bash
curl --request GET \
  --url https://demo.notifuse.com/api/blogPosts.get \
  --header 'Authorization: Bearer <token>'
```

```python
import requests

url = "https://demo.notifuse.com/api/blogPosts.get"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

```javascript
const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};

fetch('https://demo.notifuse.com/api/blogPosts.get', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://demo.notifuse.com/api/blogPosts.get",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}
```

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://demo.notifuse.com/api/blogPosts.get"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}
```

```java
HttpResponse<String> response = Unirest.get("https://demo.notifuse.com/api/blogPosts.get")
  .header("Authorization", "Bearer <token>")
  .asString();
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://demo.notifuse.com/api/blogPosts.get")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### Python: List blog posts

Source: https://docs.notifuse.com/api-reference/blog/list-blog-posts

Python example using the requests library to fetch blog posts. Requires the requests package. Replace <token> with your API token.

```python
import requests

url = "https://demo.notifuse.com/api/blogPosts.list?status=all&page=1&limit=50"

headers = {"Authorization": "Bearer <token>"}

response = requests.get(url, headers=headers)

print(response.text)
```

--------------------------------

### Ruby: List blog posts

Source: https://docs.notifuse.com/api-reference/blog/list-blog-posts

Ruby example using Net::HTTP to fetch blog posts. Replace <token> with your API token. Prints the response body.

```ruby
require 'uri'
require 'net/http'

url = URI("https://demo.notifuse.com/api/blogPosts.list?status=all&page=1&limit=50")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["Authorization"] = 'Bearer <token>'

response = http.request(request)
puts response.read_body
```

--------------------------------

### 200 response example for get contact by email

Source: https://docs.notifuse.com/api-reference/get-a-contact-by-email-address

Example 200 response body for a successful contact lookup. Contains contact details including custom fields, contact lists, and contact segments.

```json
{
  "contact": {
    "email": "user@example.com",
    "external_id": "user_12345",
    "timezone": "America/New_York",
    "language": "en-US",
    "first_name": "John",
    "last_name": "Doe",
    "full_name": "John Doe",
    "phone": "+15551234567",
    "address_line_1": "123 Main St",
    "address_line_2": "Apt 4B",
    "country": "US",
    "postcode": "10001",
    "state": "NY",
    "job_title": "Software Engineer",
    "custom_string_1": "Premium tier",
    "custom_string_2": "<string>",
    "custom_string_3": "<string>",
    "custom_string_4": "<string>",
    "custom_string_5": "<string>",
    "custom_number_1": 42,
    "custom_number_2": 123,
    "custom_number_3": 123,
    "custom_number_4": 123,
    "custom_number_5": 123,
    "custom_datetime_1": "2023-06-01T09:00:00Z",
    "custom_datetime_2": "2023-11-07T05:31:56Z",
    "custom_datetime_3": "2023-11-07T05:31:56Z",
    "custom_datetime_4": "2023-11-07T05:31:56Z",
    "custom_datetime_5": "2023-11-07T05:31:56Z",
    "custom_json_1": {
      "preferences": {
        "theme": "dark",
        "notifications": true
      }
    },
    "custom_json_2": "<unknown>",
    "custom_json_3": "<unknown>",
    "custom_json_4": "<unknown>",
    "custom_json_5": "<unknown>",
    "created_at": "2023-01-15T10:30:00Z",
    "updated_at": "2023-04-22T15:45:00Z",
    "contact_lists": [
      {
        "email": "user@example.com",
        "list_id": "newsletter",
        "list_name": "Newsletter",
        "status": "active",
        "created_at": "2023-01-15T10:30:00Z",
        "updated_at": "2023-01-15T10:30:00Z",
        "deleted_at": null
      }
    ],
    "contact_segments": [
      {
        "email": "user@example.com",
        "segment_id": "premium_users",
        "version": 1,
        "matched_at": "2023-01-15T10:30:00Z",
        "computed_at": "2023-01-15T10:30:00Z"
      }
    ]
  }
}

```

--------------------------------

### Java Unirest request to get contact by email

Source: https://docs.notifuse.com/api-reference/get-a-contact-by-email-address

Java example using Unirest to send a GET request to the Notifuse API endpoint /api/contacts.getByEmail. Sets the Authorization header with a Bearer token and returns the response as a string.

```java
HttpResponse<String> response = Unirest.get("https://demo.notifuse.com/api/contacts.getByEmail")
  .header("Authorization", "Bearer <token>")
  .asString();

```

--------------------------------

### Go net/http call to /api/user.rootSignin

Source: https://docs.notifuse.com/api-reference/authentication/root-user-programmatic-signin

Go example using the standard net/http library to POST the root signin payload. Reads the response body and prints it to stdout.

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://demo.notifuse.com/api/user.rootSignin"

	payload := strings.NewReader("{\n  \"email\": \"admin@example.com\",\n  \"timestamp\": 1735600000,\n  \"signature\": \"a1b2c3d4e5f6789012345678901234567890abcdef1234567890abcdef123456\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

```

--------------------------------

### Create a blog category with Unirest (Java)

Source: https://docs.notifuse.com/api-reference/blog/create-a-blog-category

Java example using Unirest to POST to the blogCategories.create endpoint. Requires an Authorization header with a valid token and a JSON body containing the category name, slug, description, and SEO settings.

```java
HttpResponse<String> response = Unirest.post("https://demo.notifuse.com/api/blogCategories.create")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"name\": \"Product\",\n  \"slug\": \"product\",\n  \"description\": \"Release notes and product announcements.\",\n  \"seo\": {\n    \"meta_title\": \"Release notes for October\",\n    \"meta_description\": \"Everything that shipped this month.\",\n    \"og_title\": \"<string>\",\n    \"og_description\": \"<string>\",\n    \"og_image\": \"https://cdn.example.com/og/october.png\",\n    \"canonical_url\": \"https://blog.example.com/product/october-release\",\n    \"keywords\": [\n      \"release\",\n      \"changelog\"\n    ],\n    \"meta_robots\": \"index,follow\"\n  }\n}")
  .asString();
```

--------------------------------

### Go net/http request to get contact by email

Source: https://docs.notifuse.com/api-reference/get-a-contact-by-email-address

Go example using the net/http package to send a GET request to the Notifuse API endpoint /api/contacts.getByEmail. Adds an Authorization header with a Bearer token and prints the response body.

```go
package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://demo.notifuse.com/api/contacts.getByEmail"

	req, _ := http.NewRequest("GET", url, nil)

	req.Header.Add("Authorization", "Bearer <token>")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

```

--------------------------------

### JavaScript: Create a blog theme version

Source: https://docs.notifuse.com/api-reference/blog/create-a-blog-theme-version

Uses fetch to POST the theme files and notes to the blogThemes.create endpoint. Requires an Authorization bearer token.

```javascript
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    files: {
      'home.liquid': '<string>',
      'category.liquid': '<string>',
      'post.liquid': '<string>',
      'header.liquid': '<string>',
      'footer.liquid': '<string>',
      'shared.liquid': '<string>',
      'styles.css': '<string>',
      'scripts.js': '<string>'
    },
    notes: 'Darker header, larger body text.'
  })
};

fetch('https://demo.notifuse.com/api/blogThemes.create', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));
```

--------------------------------

### PHP cURL request to get contact by email

Source: https://docs.notifuse.com/api-reference/get-a-contact-by-email-address

PHP example using cURL to send a GET request to the Notifuse API endpoint /api/contacts.getByEmail. Requires an Authorization header with a Bearer token. Outputs the response or a cURL error.

```php
<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://demo.notifuse.com/api/contacts.getByEmail",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "GET",
  CURLOPT_HTTPHEADER => [
    "Authorization: Bearer <token>"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

```

--------------------------------

### Successful response for getting a blog category

Source: https://docs.notifuse.com/api-reference/blog/get-a-blog-category

Example 200 response containing the blog category object with id, slug, settings, and timestamps.

```json
{
  "category": {
    "id": "7c9e6679-7425-40de-944b-e07fc1f90ae7",
    "slug": "product",
    "settings": {
      "name": "Product",
      "description": "Release notes and product announcements.",
      "seo": {
        "meta_title": "Release notes for October",
        "meta_description": "Everything that shipped this month.",
        "og_title": "<string>",
        "og_description": "<string>",
        "og_image": "https://cdn.example.com/og/october.png",
        "canonical_url": "https://blog.example.com/product/october-release",
        "keywords": [
          "release",
          "changelog"
        ],
        "meta_robots": "index,follow"
      }
    },
    "created_at": "2023-11-07T05:31:56Z",
    "updated_at": "2023-11-07T05:31:56Z"
  }
}
```
Tokens:
Raw