Update a project

curl --request PATCH \
  --url https://apix.spotzee.com/api/admin/projects/{projectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "website_url": "<string>",
  "locale": "<string>",
  "timezone": "<string>",
  "text_opt_out_message": "<string>",
  "text_help_message": "<string>",
  "link_wrap_email": true,
  "link_wrap_push": true,
  "track_opens_email": true,
  "deeplink_mirror_url": "<string>"
}
'

import requests

url = "https://apix.spotzee.com/api/admin/projects/{projectId}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "website_url": "<string>",
    "locale": "<string>",
    "timezone": "<string>",
    "text_opt_out_message": "<string>",
    "text_help_message": "<string>",
    "link_wrap_email": True,
    "link_wrap_push": True,
    "track_opens_email": True,
    "deeplink_mirror_url": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    website_url: '<string>',
    locale: '<string>',
    timezone: '<string>',
    text_opt_out_message: '<string>',
    text_help_message: '<string>',
    link_wrap_email: true,
    link_wrap_push: true,
    track_opens_email: true,
    deeplink_mirror_url: '<string>'
  })
};

fetch('https://apix.spotzee.com/api/admin/projects/{projectId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://apix.spotzee.com/api/admin/projects/{projectId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"text_opt_out_message\": \"<string>\",\n  \"text_help_message\": \"<string>\",\n  \"link_wrap_email\": true,\n  \"link_wrap_push\": true,\n  \"track_opens_email\": true,\n  \"deeplink_mirror_url\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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))

}

{
  "id": 42,
  "organization_id": 7,
  "name": "Acme Marketing",
  "locale": "en-AU",
  "timezone": "Australia/Sydney",
  "created_at": "2026-04-28T05:14:00.000Z",
  "updated_at": "2026-04-28T05:14:00.000Z",
  "description": "<string>",
  "website_url": "https://acme.example",
  "text_opt_out_message": "<string>",
  "text_help_message": "<string>",
  "link_wrap_email": true,
  "link_wrap_push": true,
  "track_opens_email": true,
  "deeplink_mirror_url": "https://links.acme.example",
  "role": "admin",
  "has_provider": true
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

PATCH

projects

{projectId}

Update a project

curl --request PATCH \
  --url https://apix.spotzee.com/api/admin/projects/{projectId} \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "name": "<string>",
  "description": "<string>",
  "website_url": "<string>",
  "locale": "<string>",
  "timezone": "<string>",
  "text_opt_out_message": "<string>",
  "text_help_message": "<string>",
  "link_wrap_email": true,
  "link_wrap_push": true,
  "track_opens_email": true,
  "deeplink_mirror_url": "<string>"
}
'

import requests

url = "https://apix.spotzee.com/api/admin/projects/{projectId}"

payload = {
    "name": "<string>",
    "description": "<string>",
    "website_url": "<string>",
    "locale": "<string>",
    "timezone": "<string>",
    "text_opt_out_message": "<string>",
    "text_help_message": "<string>",
    "link_wrap_email": True,
    "link_wrap_push": True,
    "track_opens_email": True,
    "deeplink_mirror_url": "<string>"
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.patch(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'PATCH',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    name: '<string>',
    description: '<string>',
    website_url: '<string>',
    locale: '<string>',
    timezone: '<string>',
    text_opt_out_message: '<string>',
    text_help_message: '<string>',
    link_wrap_email: true,
    link_wrap_push: true,
    track_opens_email: true,
    deeplink_mirror_url: '<string>'
  })
};

fetch('https://apix.spotzee.com/api/admin/projects/{projectId}', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

package main

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

func main() {

	url := "https://apix.spotzee.com/api/admin/projects/{projectId}"

	payload := strings.NewReader("{\n  \"name\": \"<string>\",\n  \"description\": \"<string>\",\n  \"website_url\": \"<string>\",\n  \"locale\": \"<string>\",\n  \"timezone\": \"<string>\",\n  \"text_opt_out_message\": \"<string>\",\n  \"text_help_message\": \"<string>\",\n  \"link_wrap_email\": true,\n  \"link_wrap_push\": true,\n  \"track_opens_email\": true,\n  \"deeplink_mirror_url\": \"<string>\"\n}")

	req, _ := http.NewRequest("PATCH", 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))

}

{
  "id": 42,
  "organization_id": 7,
  "name": "Acme Marketing",
  "locale": "en-AU",
  "timezone": "Australia/Sydney",
  "created_at": "2026-04-28T05:14:00.000Z",
  "updated_at": "2026-04-28T05:14:00.000Z",
  "description": "<string>",
  "website_url": "https://acme.example",
  "text_opt_out_message": "<string>",
  "text_help_message": "<string>",
  "link_wrap_email": true,
  "link_wrap_push": true,
  "track_opens_email": true,
  "deeplink_mirror_url": "https://links.acme.example",
  "role": "admin",
  "has_provider": true
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

{
  "status": "error",
  "code": "resource_missing",
  "message": "User usr_01HXY7Z9K8M5J2N4P6Q8R0S1T2 was not found in this project.",
  "error": "<string>",
  "title": "Resource missing",
  "type": "https://docs.spotzee.com/main-api/errors#resource_missing",
  "request_id": "req_01HXY7Z9K8M5J2N4P6Q8R0S1T2",
  "param": "id",
  "errors": [
    {
      "param": "email",
      "code": "parameter_invalid_format",
      "message": "Must be a valid email address."
    }
  ]
}

Authorizations

Authorization

string

header

required

Organisation-scoped admin API key (ok_…). Pass in the Authorization: Bearer <key> header. Used to manage projects and other organisation-level resources.

Path Parameters

projectId

integer | null

Numeric project identifier.

Example:

42

Body

application/json

Partial update of a project. Only fields included in the request body are modified.

name

string | null

Minimum string length: 1

description

string | null

website_url

string | null

Pattern: ^$|^(https?:\/\/)?([a-zA-Z0-9]([a-zA-Z0-9-]*[a-zA-Z0-9])?\.)+[a-zA-Z]{2,}(:[0-9]+)?(\/\S*)?$

locale

string | null

Required string length: 1 - 255

timezone

string | null

Required string length: 1 - 50

text_opt_out_message

string | null

text_help_message

string | null

link_wrap_email

boolean | null

link_wrap_push

boolean | null

track_opens_email

boolean | null

deeplink_mirror_url

string | null

Pattern: ^(https:\/\/|$)

Response

The updated project.

Project as seen by an organisation API key (ok_). The publishable shape excludes internal credential storage and project-scoped fields such as the caller’s project role.

integer

required

Numeric project identifier.

Example:

42

organization_id

integer

required

Identifier of the owning organisation.

Example:

7

name

string

required

Human-readable project name.

Example:

"Acme Marketing"

locale

string

required

Default BCP-47 locale used for content rendering and timestamp formatting.

Example:

"en-AU"

timezone

string

required

Default IANA timezone used for time-of-day scheduling.

Example:

"Australia/Sydney"

created_at

string | null

required

Time the project was created. ISO 8601.

Example:

"2026-04-28T05:14:00.000Z"

updated_at

string | null

required

Time the project was last modified. ISO 8601.

Example:

"2026-04-28T05:14:00.000Z"

description

string | null

Optional free-text description of the project.

website_url

string | null

The project’s public website URL, if set.

Example:

"https://acme.example"

text_opt_out_message

string | null

Custom opt-out reply for SMS recipients. When omitted, a system default is used.

text_help_message

string | null

Custom HELP reply for SMS recipients. When omitted, a system default is used.

link_wrap_email

boolean | null

When true, links in email content are rewritten through the tracking domain.

link_wrap_push

boolean | null

When true, links in push payloads are rewritten through the tracking domain.

track_opens_email

boolean | null

When true, an open-tracking pixel is embedded in outgoing email.

deeplink_mirror_url

string | null

HTTPS-only mirror URL used for Universal Links and App Links resolution.

Example:

"https://links.acme.example"

role

enum<string>

Caller’s effective role on this project. Populated on single-project responses (create/update); omitted on the list endpoint to avoid per-row joins.

Available options:

support,

smtpproxy,

editor,

publisher,

admin

Example:

"admin"

has_provider

boolean

Whether the project has at least one delivery provider configured. Populated on single-project responses; omitted on the list endpoint.

Overview

Projects

Events

Campaigns

Lists

Subscriptions

Journeys

Templates

Users

Tags

API keys

Organisation

Billing recovery

Webhooks

CRM

Source Sync

Form definitions

Form submissions

Update a project

Authorizations

Path Parameters

Body

Response