subscribe 0.1.1

The Brime Live subscription api that allows a user to be added to the contact list.

  • Contact: N/A
  • License: N/A

Resources

contact

Operations

Method and Path Description
POST /subscribe

healthcheck

Operations

Method and Path Description
GET /healthcheck

Headers

No headers

Imports

No imports

Enums

status

The available contact types able to be used in the api.

Name Value Description
subscribed subscribed

This contact has opted in to receive email marketing.

pending pending

This sends the contact a verification email for double-opted.

Interfaces

No interfaces

Models

contact

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
email_address string Yes -

personal_data

status status Yes -

contact_form

Example Json: Minimal | Full

Interfaces: None

The form to which the contact will fill out to opted in for email marketing.

Field Type Required? Default Description Annotations
email_address string Yes -

personal_data

username string Yes -

healthcheck

Example Json: Minimal | Full

Interfaces: None

Field Type Required? Default Description Annotations
status string Yes healthy

Unions

No unions

Annotations

personal_data

This field contains personally identifiable information.