Documentation Powered by ReDoc

Website facing API (1.0.0)

Download OpenAPI specification:Download

E-mail: dev@bode.co

This is an API leveraged by BODE Website

guest

Calls related to guests correlated with reservation

public

Calls related to site visitors

Registers an email address

By providing an email address, person can receive promotional codes etc.

path Parameters
propertyId
required
integer <int64>
Example: 6366

Cloudbeds property identifier

Request Body schema: application/json

Email address to add

email
required
string
tag
string

Custom tag to identify context of email registration

source
string

Source / reference from which given email originates

contactList
string

Identifier of contact list given email should be routed to

Responses

204

Email has been registered successfully

400

Bad request (i.e. missing email)

422

Email for given tag and source was already registered

post /crm/{propertyId}/email_addresses

SwaggerHub API Auto Mocking

https://virtserver.swaggerhub.com/bodeapp/website-facing-api/1.0.0/crm/{propertyId}/email_addresses

SwaggerHub API Auto Mocking

https://virtserver.swaggerhub.com/bodeapp/website-facing-api/v1/crm/{propertyId}/email_addresses

Production OPS API

https://ops.bodeapp.com/v1/crm/{propertyId}/email_addresses

Staging OPS API

https://bode-ops-app-staging.herokuapp.com/v1/crm/{propertyId}/email_addresses

Request samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "email": "tony@stark.dev",
  • "tag": "summmer-promotion",
  • "source": "website",
  • "contactList": "466a5e8c-714d-4003-9d0a-47abd28efa21"
}

Response samples

Content type
application/json
Copy
 Expand all Collapse all
{
  • "code": 1234,
  • "description": "An unhandled exception has occured"
}