Orishare
API reference
GET
/notification_settings

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/notification_settings"
{  "quiet_hours": {    "start_minute": -9007199254740991,    "end_minute": -9007199254740991  },  "max_per_day": -9007199254740991,  "max_per_week": -9007199254740991,  "email_consent_mode": "opt_in",  "default_locale": "string",  "from_name": "string",  "reply_to": "string",  "brand": {    "property1": null,    "property2": null  },  "revision": -9007199254740991,  "updated_at": "2019-08-24T14:15:22Z"}
PATCH
/notification_settings

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length
If-Match*string

Required revision, checked in the owning transaction.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/notification_settings" \  -H "Idempotency-Key: string" \  -H "If-Match: string" \  -H "Content-Type: application/json" \  -d '{    "quiet_hours": {      "start_minute": 1320,      "end_minute": 480    },    "max_per_day": 3  }'
{  "quiet_hours": {    "start_minute": -9007199254740991,    "end_minute": -9007199254740991  },  "max_per_day": -9007199254740991,  "max_per_week": -9007199254740991,  "email_consent_mode": "opt_in",  "default_locale": "string",  "from_name": "string",  "reply_to": "string",  "brand": {    "property1": null,    "property2": null  },  "revision": -9007199254740991,  "updated_at": "2019-08-24T14:15:22Z"}

List the message types Orishare knows, their triggers, variables and default copy

GET
/notification_catalog

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/notification_catalog"
{  "data": [    {      "key": "string",      "label": "string",      "description": "string",      "event_types": [        "string"      ],      "class": "marketing",      "social": true,      "variables": [        "string"      ],      "default_copy": {        "title": "string",        "body": "string"      },      "configured": true    }  ]}

List the message types this environment sends

GET
/notification_message_types

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Query Parameters

limit?integer
Range1 <= value <= 100
Default50
cursor?string

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/notification_message_types"
{  "data": [    {      "id": "string",      "key": "string",      "name": "string",      "event_types": [        "string"      ],      "status": "active",      "class": "marketing",      "routes": [        {          "channel": "email",          "path": "builtin"        }      ],      "conditions": {        "property1": null,        "property2": null      },      "max_per_day": -9007199254740991,      "max_per_week": -9007199254740991,      "respect_quiet_hours": true,      "variables": [        "string"      ],      "catalog": true,      "revision": -9007199254740991,      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string",  "has_more": true}

Send a message for an event type: pick the trigger and the delivery routes

POST
/notification_message_types

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/notification_message_types" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "key": "streak_at_risk",    "routes": [      {        "channel": "mobile_push",        "path": "builtin"      }    ]  }'
{  "id": "string",  "key": "string",  "name": "string",  "event_types": [    "string"  ],  "status": "active",  "class": "marketing",  "routes": [    {      "channel": "email",      "path": "builtin"    }  ],  "conditions": {    "property1": null,    "property2": null  },  "max_per_day": -9007199254740991,  "max_per_week": -9007199254740991,  "respect_quiet_hours": true,  "variables": [    "string"  ],  "catalog": true,  "revision": -9007199254740991,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Read one message type by id or key

GET
/notification_message_types/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/notification_message_types/string"
{  "id": "string",  "key": "string",  "name": "string",  "event_types": [    "string"  ],  "status": "active",  "class": "marketing",  "routes": [    {      "channel": "email",      "path": "builtin"    }  ],  "conditions": {    "property1": null,    "property2": null  },  "max_per_day": -9007199254740991,  "max_per_week": -9007199254740991,  "respect_quiet_hours": true,  "variables": [    "string"  ],  "catalog": true,  "revision": -9007199254740991,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Change the routes, caps, class or triggers of a message type (If-Match)

PATCH
/notification_message_types/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length
If-Match*string

Required revision, checked in the owning transaction.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/notification_message_types/string" \  -H "Idempotency-Key: string" \  -H "If-Match: string" \  -H "Content-Type: application/json" \  -d '{    "max_per_day": 1  }'
{  "id": "string",  "key": "string",  "name": "string",  "event_types": [    "string"  ],  "status": "active",  "class": "marketing",  "routes": [    {      "channel": "email",      "path": "builtin"    }  ],  "conditions": {    "property1": null,    "property2": null  },  "max_per_day": -9007199254740991,  "max_per_week": -9007199254740991,  "respect_quiet_hours": true,  "variables": [    "string"  ],  "catalog": true,  "revision": -9007199254740991,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Stop sending a message type (events still go to webhooks)

POST
/notification_message_types/{id}/pause

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/notification_message_types/string/pause" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expected_revision": 2  }'
{  "id": "string",  "key": "string",  "name": "string",  "event_types": [    "string"  ],  "status": "active",  "class": "marketing",  "routes": [    {      "channel": "email",      "path": "builtin"    }  ],  "conditions": {    "property1": null,    "property2": null  },  "max_per_day": -9007199254740991,  "max_per_week": -9007199254740991,  "respect_quiet_hours": true,  "variables": [    "string"  ],  "catalog": true,  "revision": -9007199254740991,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

Resume a paused message type

POST
/notification_message_types/{id}/resume

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/notification_message_types/string/resume" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expected_revision": 2  }'
{  "id": "string",  "key": "string",  "name": "string",  "event_types": [    "string"  ],  "status": "active",  "class": "marketing",  "routes": [    {      "channel": "email",      "path": "builtin"    }  ],  "conditions": {    "property1": null,    "property2": null  },  "max_per_day": -9007199254740991,  "max_per_week": -9007199254740991,  "respect_quiet_hours": true,  "variables": [    "string"  ],  "catalog": true,  "revision": -9007199254740991,  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z"}

List the templates of a message type, per channel and locale

GET
/notification_message_types/{id}/templates

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/notification_message_types/string/templates"
{  "data": [    {      "message_type_id": "string",      "channel": "email",      "locale": "string",      "subject": "string",      "title": "string",      "body": "string",      "html": "string",      "url": "string",      "updated_by": "string",      "updated_at": "2019-08-24T14:15:22Z"    }  ]}

Save the template of one channel and locale (creates or replaces it)

POST
/notification_message_types/{id}/templates

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/notification_message_types/string/templates" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "channel": "mobile_push",    "locale": "en",    "title": "Keep your {{streak_length}} day streak",    "body": "One lesson today keeps it alive."  }'
{  "message_type_id": "string",  "channel": "email",  "locale": "string",  "subject": "string",  "title": "string",  "body": "string",  "html": "string",  "url": "string",  "updated_by": "string",  "updated_at": "2019-08-24T14:15:22Z"}

Delete the template of one channel and locale

DELETE
/notification_message_types/{id}/templates/{channel}/{locale}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length
channel*string

Value in

  • "email"
  • "web_push"
  • "mobile_push"
locale*string
Match^[a-z]{2,3}(-[A-Za-z0-9]{2,8})*$
Lengthlength <= 35

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X DELETE "https://example.com/notification_message_types/string/templates/email/string"
Empty

List recorded messages and their delivery status, newest first

GET
/notification_messages

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Query Parameters

limit?integer
Range1 <= value <= 100
Default50
cursor?string
customer_id?string
Length1 <= length <= 255
type_key?string
Length1 <= length <= 60
status?string

Value in

  • "scheduled"
  • "sending"
  • "sent"
  • "delivered"
  • "failed"
  • "bounced"
  • "suppressed"
channel?string

Value in

  • "email"
  • "web_push"
  • "mobile_push"
  • "connector"

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/notification_messages"
{  "data": [    {      "id": "string",      "message_type_id": "string",      "type_key": "string",      "event_type": "string",      "customer_id": "string",      "actor_customer_id": "string",      "channel": "email",      "path": "builtin",      "status": "scheduled",      "reason": "string",      "send_at": "2019-08-24T14:15:22Z",      "expires_at": "2019-08-24T14:15:22Z",      "attempts": -9007199254740991,      "provider": "string",      "provider_message_id": "string",      "locale": "string",      "data": {        "property1": null,        "property2": null      },      "rendered": {        "property1": null,        "property2": null      },      "created_at": "2019-08-24T14:15:22Z",      "updated_at": "2019-08-24T14:15:22Z",      "sent_at": "2019-08-24T14:15:22Z"    }  ],  "next_cursor": "string",  "has_more": true}

Count messages by type, channel, status and reason (default: the last 7 days)

GET
/notification_message_stats

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Query Parameters

since?string
Match^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$
Formatdate-time

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/notification_message_stats"
{  "since": "2019-08-24T14:15:22Z",  "data": [    {      "type_key": "string",      "channel": "email",      "status": "scheduled",      "reason": "string",      "count": -9007199254740991    }  ]}

Read one recorded message

GET
/notification_messages/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/notification_messages/string"
{  "id": "string",  "message_type_id": "string",  "type_key": "string",  "event_type": "string",  "customer_id": "string",  "actor_customer_id": "string",  "channel": "email",  "path": "builtin",  "status": "scheduled",  "reason": "string",  "send_at": "2019-08-24T14:15:22Z",  "expires_at": "2019-08-24T14:15:22Z",  "attempts": -9007199254740991,  "provider": "string",  "provider_message_id": "string",  "locale": "string",  "data": {    "property1": null,    "property2": null  },  "rendered": {    "property1": null,    "property2": null  },  "created_at": "2019-08-24T14:15:22Z",  "updated_at": "2019-08-24T14:15:22Z",  "sent_at": "2019-08-24T14:15:22Z"}
GET
/customers/{id}/notification_contact

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length <= 255

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/customers/string/notification_contact"
{  "customer_id": "string",  "email": "string",  "email_state": "ok",  "email_consent": "unknown",  "push_consent": "unknown",  "locale": "string",  "unsubscribed_all": true,  "updated_at": "2019-08-24T14:15:22Z",  "reachable": {    "email": true,    "web_push": true,    "mobile_push": true  }}
POST
/customers/{id}/notification_contact

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length <= 255

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/customers/string/notification_contact" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "email": "[email protected]",    "locale": "en",    "email_consent": "opted_in"  }'
{  "customer_id": "string",  "email": "string",  "email_state": "ok",  "email_consent": "unknown",  "push_consent": "unknown",  "locale": "string",  "unsubscribed_all": true,  "updated_at": "2019-08-24T14:15:22Z"}

List a customer's push devices (never the tokens)

GET
/customers/{id}/notification_devices

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length <= 255

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/customers/string/notification_devices"
{  "data": [    {      "id": "string",      "kind": "web_push",      "platform": "string",      "locale": "string",      "status": "active",      "created_at": "2019-08-24T14:15:22Z",      "last_seen_at": "2019-08-24T14:15:22Z"    }  ]}

Read what a customer has opted out of, per message type and channel

GET
/customers/{id}/notification_preferences

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length <= 255

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/customers/string/notification_preferences"
{  "unsubscribed_all": true,  "email_consent": "unknown",  "push_consent": "unknown",  "all_types": {    "email": true,    "web_push": true,    "mobile_push": true  },  "types": [    {      "type_key": "string",      "name": "string",      "class": "marketing",      "channels": {        "email": true,        "web_push": true,        "mobile_push": true      }    }  ]}

Record a customer's opt-outs or opt-ins on their behalf

POST
/customers/{id}/notification_preferences

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length <= 255

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/customers/string/notification_preferences" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "types": [      {        "type_key": "streak_at_risk",        "channel": "email",        "opted_out": true      }    ]  }'
{  "unsubscribed_all": true,  "email_consent": "unknown",  "push_consent": "unknown",  "all_types": {    "email": true,    "web_push": true,    "mobile_push": true  },  "types": [    {      "type_key": "string",      "name": "string",      "class": "marketing",      "channels": {        "email": true,        "web_push": true,        "mobile_push": true      }    }  ]}
GET
/notifications/unsubscribe

Query Parameters

token?string|array<string>

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/notifications/unsubscribe"
{  "unsubscribed": true,  "type_key": "string",  "channel": "all",  "preferences": {    "unsubscribed_all": true,    "email_consent": "unknown",    "push_consent": "unknown",    "all_types": {      "email": true,      "web_push": true,      "mobile_push": true    },    "types": [      {        "type_key": "string",        "name": "string",        "class": "marketing",        "channels": {          "email": true,          "web_push": true,          "mobile_push": true        }      }    ]  }}
POST
/notifications/unsubscribe

Query Parameters

token?string|array<string>

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/notifications/unsubscribe"
{  "unsubscribed": true,  "type_key": "string",  "channel": "all",  "preferences": {    "unsubscribed_all": true,    "email_consent": "unknown",    "push_consent": "unknown",    "all_types": {      "email": true,      "web_push": true,      "mobile_push": true    },    "types": [      {        "type_key": "string",        "name": "string",        "class": "marketing",        "channels": {          "email": true,          "web_push": true,          "mobile_push": true        }      }    ]  }}
GET
/notifications/preferences

Query Parameters

token?string|array<string>

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/notifications/preferences"
{  "unsubscribed": true,  "type_key": "string",  "channel": "all",  "preferences": {    "unsubscribed_all": true,    "email_consent": "unknown",    "push_consent": "unknown",    "all_types": {      "email": true,      "web_push": true,      "mobile_push": true    },    "types": [      {        "type_key": "string",        "name": "string",        "class": "marketing",        "channels": {          "email": true,          "web_push": true,          "mobile_push": true        }      }    ]  }}

Receive a Resend email event (Svix signed): bounces and complaints mark the address and the message

POST
/notification_provider_events/resend

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/notification_provider_events/resend" \  -H "Content-Type: application/json" \  -d '{    "type": "email.bounced",    "created_at": "2026-10-05T09:00:00.000Z",    "data": {      "email_id": "4ef9a417-02e9-4d39-ad75-9611e0fcc33c",      "to": [        "[email protected]"      ],      "bounce": {        "type": "Permanent"      }    }  }'
{  "received": true,  "applied": true,  "duplicate": true}

List the connectors to the customer's own messaging tools (never the credentials)

GET
/notification_connectors

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/notification_connectors"
{  "data": [    {      "id": "string",      "kind": "klaviyo",      "name": "string",      "status": "active",      "settings": {        "property1": "string",        "property2": "string"      },      "credential_hint": "string",      "revision": -9007199254740991,      "last_error": "string",      "created_at": "string",      "updated_at": "string"    }  ]}

Connect Klaviyo, Braze, OneSignal or Firebase Cloud Messaging (credentials are sealed and never shown again)

POST
/notification_connectors

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/notification_connectors" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "kind": "braze",    "name": "Braze production",    "credentials": {      "api_key": "your-braze-rest-api-key",      "rest_endpoint": "https://rest.iad-01.braze.com"    }  }'
{  "id": "string",  "kind": "klaviyo",  "name": "string",  "status": "active",  "settings": {    "property1": "string",    "property2": "string"  },  "credential_hint": "string",  "revision": -9007199254740991,  "last_error": "string",  "created_at": "string",  "updated_at": "string"}

Read one connector (never the credentials)

GET
/notification_connectors/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X GET "https://example.com/notification_connectors/string"
{  "id": "string",  "kind": "klaviyo",  "name": "string",  "status": "active",  "settings": {    "property1": "string",    "property2": "string"  },  "credential_hint": "string",  "revision": -9007199254740991,  "last_error": "string",  "created_at": "string",  "updated_at": "string"}

Rename a connector or replace its credentials (If-Match)

PATCH
/notification_connectors/{id}

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length
If-Match*string

Required revision, checked in the owning transaction.

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X PATCH "https://example.com/notification_connectors/string" \  -H "Idempotency-Key: string" \  -H "If-Match: string" \  -H "Content-Type: application/json" \  -d '{    "name": "Braze"  }'
{  "id": "string",  "kind": "klaviyo",  "name": "string",  "status": "active",  "settings": {    "property1": "string",    "property2": "string"  },  "credential_hint": "string",  "revision": -9007199254740991,  "last_error": "string",  "created_at": "string",  "updated_at": "string"}

Stop sending through a connector

POST
/notification_connectors/{id}/disable

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/notification_connectors/string/disable" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expected_revision": 1  }'
{  "id": "string",  "kind": "klaviyo",  "name": "string",  "status": "active",  "settings": {    "property1": "string",    "property2": "string"  },  "credential_hint": "string",  "revision": -9007199254740991,  "last_error": "string",  "created_at": "string",  "updated_at": "string"}

Use a disabled connector again

POST
/notification_connectors/{id}/enable

Authorization

AuthorizationBearer <token>

Secret API key bound to an environment.

In: header

Path Parameters

id*string
Length1 <= length

Header Parameters

Idempotency-Key*string

Required. Official clients generate a UUID when omitted by the caller.

Length1 <= length <= 255
X-Orishare-Environment?string

Required for selected-environment authorization branches; API keys use their bound environment.

Length1 <= length
X-Orishare-Audit-Reason?string

Required for staff authorization. Records the reason for staff access.

Length1 <= length

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/notification_connectors/string/enable" \  -H "Idempotency-Key: string" \  -H "Content-Type: application/json" \  -d '{    "expected_revision": 1  }'
{  "id": "string",  "kind": "klaviyo",  "name": "string",  "status": "active",  "settings": {    "property1": "string",    "property2": "string"  },  "credential_hint": "string",  "revision": -9007199254740991,  "last_error": "string",  "created_at": "string",  "updated_at": "string"}

Management

Organizations, projects, environments, API keys and usage.

Partner rewards

Gift-card suppliers and brand partners: catalogue items, offer links, orders, reconciliation and settlement.