Skip to content
Optizmo API

Overview

Deploy API 1.0.0

Section titled “Deploy API 1.0.0”

The Deploy API v1 allows you to programmatically manage, automate, and configure your contacts, brands, workflows and more on Deploy.

Base URL

All API endpoints are relative to the following base URL:

https://api.optizmo.com/deploy/v1/

Authentication

All API endpoints require authentication. To become authenticated you will need your Optizmo API key which is found on the Account Details page.

The API key needs to be sent with every request as an Authorization header:

Authorization: Bearer <API key>

Rate Limiting

API endpoints are rate limited to ensure stable and fair access to the API.

Refer to the x-rate-limit-limit, x-rate-limit-remaining, and x-rate-limit-reset response headers for rate limit information.

Errors

Any error response with an HTTP status of 400–599 is an RFC 9457 Problem Details object:

{
  "type": "https://docs.optizmo.com/deploy/error-codes#invalid_request_error",
  "status": 400,
  "title": "Invalid request",
  "detail": "...",
  "code": "invalid_request_error",
  "instance": "/deploy/v1/contacts"
}
  • type — A URI pointing to the documentation for the specific error code.
  • status — The HTTP status code.
  • title — A short, human-readable summary of the problem type.
  • detail — A human-readable explanation specific to this occurrence of the problem.
  • instance — The request URI for this specific error occurrence.
  • code — The application specific error code (e.g. invalid_request_error, contact_exists, api_error).
  • errors — An array of errors, each with a detail and a pointer (JSON Pointer into the body) or parameter (query parameter name).

Information

  • OpenAPI version: 3.1.0

Operations

Section titled “ Operations ”
POST
/v1/contacts
GET
/v1/contacts/{emailMd5}
PATCH
/v1/contacts/{emailMd5}
POST
/v1/contacts/{emailMd5}/disable
GET
/v1/contacts/{emailMd5}/subscriptions
POST
/v1/contacts/{emailMd5}/subscriptions
DELETE
/v1/contacts/{emailMd5}/subscriptions/{brandId}
GET
/v1/brands
GET
/v1/brands/{brandId}
GET
/v1/contact-schema

Authentication

Section titled “ Authentication ”

optizmo_api_key

Section titled “optizmo_api_key ”

All requests to the api are authenticated using an API key generated for your account.

To get your API key, log in to https://next.optizmo.com/ and open your Account Details page.

The API key should be provided in the Authorization header as a bearer token:

Authorization: Bearer <API key>

Security scheme type: apiKey

Header parameter name: Authorization