{ "openapi": "3.1.0", "info": { "title": "Mateo API", "description": "The official API for Mateo", "version": "1.0.0" }, "servers": [{ "url": "https://integration.getmateo.com/api/v1" }], "externalDocs": { "description": "Documentation for Mateo API", "url": "https://docs.getmateo.com" }, "security": [{ "bearerAuth": [] }], "paths": { "/": { "get": { "tags": ["Introspection"], "summary": "Open API Schema", "responses": { "200": { "description": "OK", "content": {} } }, "description": "Returns the Open API Schema" } }, "/segment": { "get": { "tags": ["Segment"], "parameters": [ { "name": "id", "in": "query", "description": "Segment ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Segment creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of segment", "schema": { "type": "string" } }, { "name": "is_default", "in": "query", "description": "Is the segment set as default", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/segment" } } } } } }, "summary": "List Segments", "description": "Retrieve a list of segments" } }, "/appointment": { "get": { "tags": ["Appointment"], "parameters": [ { "name": "id", "in": "query", "description": "Appointment ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the appointment", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Description of the appointment", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "status_key", "in": "query", "description": "Status Key", "schema": { "type": "string" } }, { "name": "type_key", "in": "query", "description": "Type Key", "schema": { "type": "string" } }, { "name": "assignee_id", "in": "query", "description": "Assignee ID", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "start_time", "in": "query", "description": "Start time of the appointment", "schema": { "type": "string" } }, { "name": "end_time", "in": "query", "description": "End time of the appointment", "schema": { "type": "string" } }, { "name": "confirmed_at", "in": "query", "description": "Confirmed at timestamp", "schema": { "type": "string" } }, { "name": "cancelled_at", "in": "query", "description": "Cancelled at timestamp", "schema": { "type": "string" } }, { "name": "location_id", "in": "query", "description": "Location ID", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `start_time`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/appointment" } } } } } }, "summary": "List Appointments", "description": "Retrieve a list of appointments" } }, "/calendar": { "get": { "tags": ["Calendar"], "parameters": [ { "name": "id", "in": "query", "description": "Calendar ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the calendar", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Calendar type (virtual or provider). Only virtual calendars can be created via the API.", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `created_at`, `updated_at`, `name`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/calendar" } } } } } }, "summary": "List Calendars", "description": "Retrieve a list of calendars" }, "post": { "tags": ["Calendar"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/calendar" } } }, "description": "calendar", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/calendar" } } }, "description": "The updated Calendar object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Calendar", "$ref": "#/components/schemas/calendar" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Calendar was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "calendar", "summary": "Create Calendar", "description": "Create a new calendar" }, "delete": { "tags": ["Calendar"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Calendar ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the calendar", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Calendar type (virtual or provider). Only virtual calendars can be created via the API.", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/calendar" } } }, "description": "The updated Calendar object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Calendar", "description": "Delete an existing calendar" }, "patch": { "tags": ["Calendar"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Calendar ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the calendar", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Calendar type (virtual or provider). Only virtual calendars can be created via the API.", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/calendar" } } }, "description": "calendar", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/calendar" } } }, "description": "The updated Calendar object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "calendar", "summary": "Update Calendar", "description": "Update an existing calendar" } }, "/deal": { "get": { "tags": ["Deal"], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the deal", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "type_key", "in": "query", "description": "Type Key", "schema": { "type": "string" } }, { "name": "status_key", "in": "query", "description": "Status Key", "schema": { "type": "string" } }, { "name": "assignee_id", "in": "query", "description": "Assignee ID", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value of the deal", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Currency of the deal", "schema": { "type": "string" } }, { "name": "won_at", "in": "query", "description": "Won at timestamp", "schema": { "type": "string" } }, { "name": "lost_at", "in": "query", "description": "Lost at timestamp", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `lost_at`, `won_at`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/deal" } } } } } }, "summary": "List Deals", "description": "Retrieve a list of deals" }, "post": { "tags": ["Deal"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal" } } }, "description": "deal", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal" } } }, "description": "The updated Deal object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Deal", "$ref": "#/components/schemas/deal" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Deal was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "deal", "summary": "Create Deal", "description": "Create a new deal" }, "delete": { "tags": ["Deal"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the deal", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "type_key", "in": "query", "description": "Type Key", "schema": { "type": "string" } }, { "name": "status_key", "in": "query", "description": "Status Key", "schema": { "type": "string" } }, { "name": "assignee_id", "in": "query", "description": "Assignee ID", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value of the deal", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Currency of the deal", "schema": { "type": "string" } }, { "name": "won_at", "in": "query", "description": "Won at timestamp", "schema": { "type": "string" } }, { "name": "lost_at", "in": "query", "description": "Lost at timestamp", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal" } } }, "description": "The updated Deal object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Deal", "description": "Delete an existing deal" }, "patch": { "tags": ["Deal"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the deal", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "type_key", "in": "query", "description": "Type Key", "schema": { "type": "string" } }, { "name": "status_key", "in": "query", "description": "Status Key", "schema": { "type": "string" } }, { "name": "assignee_id", "in": "query", "description": "Assignee ID", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value of the deal", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Currency of the deal", "schema": { "type": "string" } }, { "name": "won_at", "in": "query", "description": "Won at timestamp", "schema": { "type": "string" } }, { "name": "lost_at", "in": "query", "description": "Lost at timestamp", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal" } } }, "description": "deal", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal" } } }, "description": "The updated Deal object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "deal", "summary": "Update Deal", "description": "Update an existing deal" } }, "/contact_custom_field": { "get": { "tags": ["Contact Custom Field"], "parameters": [ { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "custom_field_id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Contact custom field creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Contact custom field key", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value of contact custom field", "schema": { "type": "string" } }, { "name": "date_value", "in": "query", "description": "Date value", "schema": { "type": "string" } }, { "name": "string_value", "in": "query", "description": "String value", "schema": { "type": "string" } }, { "name": "number_value", "in": "query", "description": "Number value", "schema": { "type": "string" } }, { "name": "boolean_value", "in": "query", "description": "Boolean value", "schema": { "type": "string" } }, { "name": "datetime_value", "in": "query", "description": "Datetime value", "schema": { "type": "string" } }, { "name": "string_list_value", "in": "query", "description": "String list value", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/contact_custom_field" } } } } } }, "summary": "List Contact Custom Fields", "description": "Retrieve a list of contact custom fields" }, "post": { "tags": ["Contact Custom Field"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_custom_field" } } }, "description": "contact_custom_field", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_custom_field" } } }, "description": "The updated Contact Custom Field object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Contact Custom Field", "$ref": "#/components/schemas/contact_custom_field" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Contact Custom Field was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "contact_custom_field", "summary": "Create Contact Custom Field", "description": "Create a new contact custom field" }, "delete": { "tags": ["Contact Custom Field"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "custom_field_id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Contact custom field creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Contact custom field key", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value of contact custom field", "schema": { "type": "string" } }, { "name": "date_value", "in": "query", "description": "Date value", "schema": { "type": "string" } }, { "name": "string_value", "in": "query", "description": "String value", "schema": { "type": "string" } }, { "name": "number_value", "in": "query", "description": "Number value", "schema": { "type": "string" } }, { "name": "boolean_value", "in": "query", "description": "Boolean value", "schema": { "type": "string" } }, { "name": "datetime_value", "in": "query", "description": "Datetime value", "schema": { "type": "string" } }, { "name": "string_list_value", "in": "query", "description": "String list value", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_custom_field" } } }, "description": "The updated Contact Custom Field object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Contact Custom Field", "description": "Delete an existing contact custom field" }, "patch": { "tags": ["Contact Custom Field"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "custom_field_id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Contact custom field creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Contact custom field key", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value of contact custom field", "schema": { "type": "string" } }, { "name": "date_value", "in": "query", "description": "Date value", "schema": { "type": "string" } }, { "name": "string_value", "in": "query", "description": "String value", "schema": { "type": "string" } }, { "name": "number_value", "in": "query", "description": "Number value", "schema": { "type": "string" } }, { "name": "boolean_value", "in": "query", "description": "Boolean value", "schema": { "type": "string" } }, { "name": "datetime_value", "in": "query", "description": "Datetime value", "schema": { "type": "string" } }, { "name": "string_list_value", "in": "query", "description": "String list value", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_custom_field" } } }, "description": "contact_custom_field", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_custom_field" } } }, "description": "The updated Contact Custom Field object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "contact_custom_field", "summary": "Update Contact Custom Field", "description": "Update an existing contact custom field" } }, "/appointment_custom_field": { "get": { "tags": ["Appointment Custom Field"], "parameters": [ { "name": "appointment_id", "in": "query", "description": "Appointment ID", "schema": { "type": "string" } }, { "name": "custom_field_id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Appointment custom field creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Appointment custom field key", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value of appointment custom field", "schema": { "type": "string" } }, { "name": "date_value", "in": "query", "description": "Date value", "schema": { "type": "string" } }, { "name": "string_value", "in": "query", "description": "String value", "schema": { "type": "string" } }, { "name": "number_value", "in": "query", "description": "Number value", "schema": { "type": "string" } }, { "name": "boolean_value", "in": "query", "description": "Boolean value", "schema": { "type": "string" } }, { "name": "datetime_value", "in": "query", "description": "Datetime value", "schema": { "type": "string" } }, { "name": "string_list_value", "in": "query", "description": "String list value", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/appointment_custom_field" } } } } } }, "summary": "List Appointment Custom Fields", "description": "Retrieve a list of appointment custom fields" }, "post": { "tags": ["Appointment Custom Field"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appointment_custom_field" } } }, "description": "appointment_custom_field", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appointment_custom_field" } } }, "description": "The updated Appointment Custom Field object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Appointment Custom Field", "$ref": "#/components/schemas/appointment_custom_field" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Appointment Custom Field was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "appointment_custom_field", "summary": "Create Appointment Custom Field", "description": "Create a new appointment custom field" }, "delete": { "tags": ["Appointment Custom Field"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "appointment_id", "in": "query", "description": "Appointment ID", "schema": { "type": "string" } }, { "name": "custom_field_id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Appointment custom field creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Appointment custom field key", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value of appointment custom field", "schema": { "type": "string" } }, { "name": "date_value", "in": "query", "description": "Date value", "schema": { "type": "string" } }, { "name": "string_value", "in": "query", "description": "String value", "schema": { "type": "string" } }, { "name": "number_value", "in": "query", "description": "Number value", "schema": { "type": "string" } }, { "name": "boolean_value", "in": "query", "description": "Boolean value", "schema": { "type": "string" } }, { "name": "datetime_value", "in": "query", "description": "Datetime value", "schema": { "type": "string" } }, { "name": "string_list_value", "in": "query", "description": "String list value", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appointment_custom_field" } } }, "description": "The updated Appointment Custom Field object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Appointment Custom Field", "description": "Delete an existing appointment custom field" }, "patch": { "tags": ["Appointment Custom Field"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "appointment_id", "in": "query", "description": "Appointment ID", "schema": { "type": "string" } }, { "name": "custom_field_id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Appointment custom field creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Appointment custom field key", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value of appointment custom field", "schema": { "type": "string" } }, { "name": "date_value", "in": "query", "description": "Date value", "schema": { "type": "string" } }, { "name": "string_value", "in": "query", "description": "String value", "schema": { "type": "string" } }, { "name": "number_value", "in": "query", "description": "Number value", "schema": { "type": "string" } }, { "name": "boolean_value", "in": "query", "description": "Boolean value", "schema": { "type": "string" } }, { "name": "datetime_value", "in": "query", "description": "Datetime value", "schema": { "type": "string" } }, { "name": "string_list_value", "in": "query", "description": "String list value", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appointment_custom_field" } } }, "description": "appointment_custom_field", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appointment_custom_field" } } }, "description": "The updated Appointment Custom Field object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "appointment_custom_field", "summary": "Update Appointment Custom Field", "description": "Update an existing appointment custom field" } }, "/deal_type": { "get": { "tags": ["Deal Type"], "parameters": [ { "name": "id", "in": "query", "description": "Deal type ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the deal type", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Key of the deal type", "schema": { "type": "string" } }, { "name": "emoji", "in": "query", "description": "Emoji of the deal type", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/deal_type" } } } } } }, "summary": "List Deal Types", "description": "Retrieve a list of deal types" } }, "/event": { "get": { "tags": ["Event"], "parameters": [ { "name": "id", "in": "query", "description": "Event ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Event creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "conversation_id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type of event", "schema": { "type": "string" } }, { "name": "source_type", "in": "query", "description": "Source type", "schema": { "type": "string" } }, { "name": "target_type", "in": "query", "description": "Target type", "schema": { "type": "string" } }, { "name": "metadata", "in": "query", "description": "Metadata of event", "schema": { "type": "string" } }, { "name": "source_employee_id", "in": "query", "description": "Source employee ID", "schema": { "type": "string" } }, { "name": "source_api_token_id", "in": "query", "description": "Source API token ID", "schema": { "type": "string" } }, { "name": "source_comment_id", "in": "query", "description": "Source comment ID", "schema": { "type": "string" } }, { "name": "source_channel_id", "in": "query", "description": "Source channel ID", "schema": { "type": "string" } }, { "name": "source_recipient_id", "in": "query", "description": "Source recipient ID", "schema": { "type": "string" } }, { "name": "target_employee_id", "in": "query", "description": "Target employee ID", "schema": { "type": "string" } }, { "name": "target_comment_id", "in": "query", "description": "Target comment ID", "schema": { "type": "string" } }, { "name": "target_message_id", "in": "query", "description": "Target message ID", "schema": { "type": "string" } }, { "name": "target_tag_id", "in": "query", "description": "Target tag ID", "schema": { "type": "string" } }, { "name": "target_message_action_id", "in": "query", "description": "Target message action ID", "schema": { "type": "string" } }, { "name": "target_inbox_id", "in": "query", "description": "Target inbox ID", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `created_at`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/event" } } } } } }, "summary": "List Events", "description": "Retrieve a list of events" } }, "/appointment_status": { "get": { "tags": ["Appointment Status"], "parameters": [ { "name": "id", "in": "query", "description": "Appointment status ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "appointment_type_id", "in": "query", "description": "Appointment type ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the appointment status", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type of the appointment status", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Key of the appointment status", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/appointment_status" } } } } } }, "summary": "List Appointment Status", "description": "Retrieve a list of appointment status" } }, "/marketing_subscription": { "get": { "tags": ["Marketing Subscription"], "parameters": [ { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "marketing_channel_id", "in": "query", "description": "Marketing channel ID", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Marketing subscription creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Marketing subscription key", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status of Marketing subscription", "schema": { "type": "string" } }, { "name": "channel_type", "in": "query", "description": "Channel Type of Conversation", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/marketing_subscription" } } } } } }, "summary": "List Marketing Subscriptions", "description": "Retrieve a list of marketing subscriptions" }, "post": { "tags": ["Marketing Subscription"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketing_subscription" } } }, "description": "marketing_subscription", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketing_subscription" } } }, "description": "The updated Marketing Subscription object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Marketing Subscription", "$ref": "#/components/schemas/marketing_subscription" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Marketing Subscription was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "marketing_subscription", "summary": "Create Marketing Subscription", "description": "Create a new marketing subscription" }, "delete": { "tags": ["Marketing Subscription"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "marketing_channel_id", "in": "query", "description": "Marketing channel ID", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Marketing subscription creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Marketing subscription key", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status of Marketing subscription", "schema": { "type": "string" } }, { "name": "channel_type", "in": "query", "description": "Channel Type of Conversation", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketing_subscription" } } }, "description": "The updated Marketing Subscription object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Marketing Subscription", "description": "Delete an existing marketing subscription" }, "patch": { "tags": ["Marketing Subscription"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "marketing_channel_id", "in": "query", "description": "Marketing channel ID", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Marketing subscription creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Marketing subscription key", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status of Marketing subscription", "schema": { "type": "string" } }, { "name": "channel_type", "in": "query", "description": "Channel Type of Conversation", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketing_subscription" } } }, "description": "marketing_subscription", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketing_subscription" } } }, "description": "The updated Marketing Subscription object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "marketing_subscription", "summary": "Update Marketing Subscription", "description": "Update an existing marketing subscription" } }, "/message": { "get": { "tags": ["Message"], "parameters": [ { "name": "id", "in": "query", "description": "Message ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Message creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "conversation_id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" } }, { "name": "is_inbound", "in": "query", "description": "Is the message inbound?", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Subject of message", "schema": { "type": "string" } }, { "name": "author_id", "in": "query", "description": "Author ID", "schema": { "type": "string" } }, { "name": "content", "in": "query", "description": "Content of message", "schema": { "type": "string" } }, { "name": "raw_content", "in": "query", "description": "Raw content of message", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status of message", "schema": { "type": "string" } }, { "name": "attachment_count", "in": "query", "description": "Attachment count of message", "schema": { "type": "string" } }, { "name": "reply_to_message_id", "in": "query", "description": "Reply to message ID", "schema": { "type": "string" } }, { "name": "external_files", "in": "query", "description": "External files of message", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "template_id", "in": "query", "description": "Template ID", "schema": { "type": "string" } }, { "name": "review_channel_id", "in": "query", "description": "Review Channel ID", "schema": { "type": "string" } }, { "name": "author_type", "in": "query", "description": "Author type of message", "schema": { "type": "string" } }, { "name": "forwarded", "in": "query", "description": "Is message forwarded?", "schema": { "type": "string" } }, { "name": "forwarded_message_text", "in": "query", "description": "Forwarded Message text", "schema": { "type": "string" } }, { "name": "send_after", "in": "query", "description": "Message send after", "schema": { "type": "string" } }, { "name": "footer", "in": "query", "description": "Message footer", "schema": { "type": "string" } }, { "name": "sendout_id", "in": "query", "description": "Sendout ID", "schema": { "type": "string" } }, { "name": "campaign_id", "in": "query", "description": "Campaign ID", "schema": { "type": "string" } }, { "name": "sent_at", "in": "query", "description": "Message sent at", "schema": { "type": "string" } }, { "name": "timestamp", "in": "query", "description": "Timestamp of message", "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Coordinates that are shared via chat", "schema": { "type": "string" } }, { "name": "location_metadata", "in": "query", "description": "Location metadata of message", "schema": { "type": "string" } }, { "name": "contacts", "in": "query", "description": "Contacts of message", "schema": { "type": "string" } }, { "name": "files", "in": "query", "description": "Files shared with the message", "schema": { "type": "string" } }, { "name": "header_media_filename", "in": "query", "description": "Header media filename of message", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `timestamp`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/message" } } } } } }, "summary": "List Messages", "description": "Retrieve a list of messages" }, "delete": { "tags": ["Message"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Message ID", "schema": { "type": "string" }, "required": true }, { "name": "created_at", "in": "query", "description": "Message creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "conversation_id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" } }, { "name": "is_inbound", "in": "query", "description": "Is the message inbound?", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Subject of message", "schema": { "type": "string" } }, { "name": "author_id", "in": "query", "description": "Author ID", "schema": { "type": "string" } }, { "name": "content", "in": "query", "description": "Content of message", "schema": { "type": "string" } }, { "name": "raw_content", "in": "query", "description": "Raw content of message", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status of message", "schema": { "type": "string" } }, { "name": "attachment_count", "in": "query", "description": "Attachment count of message", "schema": { "type": "string" } }, { "name": "reply_to_message_id", "in": "query", "description": "Reply to message ID", "schema": { "type": "string" } }, { "name": "external_files", "in": "query", "description": "External files of message", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "template_id", "in": "query", "description": "Template ID", "schema": { "type": "string" } }, { "name": "review_channel_id", "in": "query", "description": "Review Channel ID", "schema": { "type": "string" } }, { "name": "author_type", "in": "query", "description": "Author type of message", "schema": { "type": "string" } }, { "name": "forwarded", "in": "query", "description": "Is message forwarded?", "schema": { "type": "string" } }, { "name": "forwarded_message_text", "in": "query", "description": "Forwarded Message text", "schema": { "type": "string" } }, { "name": "send_after", "in": "query", "description": "Message send after", "schema": { "type": "string" } }, { "name": "footer", "in": "query", "description": "Message footer", "schema": { "type": "string" } }, { "name": "sendout_id", "in": "query", "description": "Sendout ID", "schema": { "type": "string" } }, { "name": "campaign_id", "in": "query", "description": "Campaign ID", "schema": { "type": "string" } }, { "name": "sent_at", "in": "query", "description": "Message sent at", "schema": { "type": "string" } }, { "name": "timestamp", "in": "query", "description": "Timestamp of message", "schema": { "type": "string" } }, { "name": "location", "in": "query", "description": "Coordinates that are shared via chat", "schema": { "type": "string" } }, { "name": "location_metadata", "in": "query", "description": "Location metadata of message", "schema": { "type": "string" } }, { "name": "contacts", "in": "query", "description": "Contacts of message", "schema": { "type": "string" } }, { "name": "files", "in": "query", "description": "Files shared with the message", "schema": { "type": "string" } }, { "name": "header_media_filename", "in": "query", "description": "Header media filename of message", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/message" } } }, "description": "The updated Message object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Message", "description": "Delete an existing message" } }, "/channel": { "get": { "tags": ["Channel"], "parameters": [ { "name": "id", "in": "query", "description": "Channel ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Channel creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Channel type", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of channel", "schema": { "type": "string" } }, { "name": "handle", "in": "query", "description": "Channel handle", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status of channel", "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Is channel active?", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `name`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/channel" } } } } } }, "summary": "List Channels", "description": "Retrieve a list of channels" } }, "/custom_field": { "get": { "tags": ["Custom Field"], "parameters": [ { "name": "id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Custom field creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of custom field", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Custom field description", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Typ of custom field", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Custom field key", "schema": { "type": "string" } }, { "name": "entity", "in": "query", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/custom_field" } } } } } }, "summary": "List Custom Fields", "description": "Retrieve a list of custom fields" }, "post": { "tags": ["Custom Field"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_field" } } }, "description": "custom_field", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_field" } } }, "description": "The updated Custom Field object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Custom Field", "$ref": "#/components/schemas/custom_field" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Custom Field was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "custom_field", "summary": "Create Custom Field", "description": "Create a new custom field" }, "delete": { "tags": ["Custom Field"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" }, "required": true }, { "name": "created_at", "in": "query", "description": "Custom field creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of custom field", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Custom field description", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Typ of custom field", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Custom field key", "schema": { "type": "string" } }, { "name": "entity", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_field" } } }, "description": "The updated Custom Field object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Custom Field", "description": "Delete an existing custom field" }, "patch": { "tags": ["Custom Field"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" }, "required": true }, { "name": "created_at", "in": "query", "description": "Custom field creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of custom field", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Custom field description", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Typ of custom field", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Custom field key", "schema": { "type": "string" } }, { "name": "entity", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_field" } } }, "description": "custom_field", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_field" } } }, "description": "The updated Custom Field object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "custom_field", "summary": "Update Custom Field", "description": "Update an existing custom field" } }, "/tag": { "get": { "tags": ["Tag"], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } }, { "name": "color", "in": "query", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `name`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/tag" } } } } } }, "summary": "List Tags", "description": "Retrieve a list of tags" }, "post": { "tags": ["Tag"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, "description": "tag", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, "description": "The updated Tag object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Tag", "$ref": "#/components/schemas/tag" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Tag was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "tag", "summary": "Create Tag", "description": "Create a new tag" }, "delete": { "tags": ["Tag"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "created_at", "in": "query", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } }, { "name": "color", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, "description": "The updated Tag object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Tag", "description": "Delete an existing tag" }, "patch": { "tags": ["Tag"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" }, "required": true }, { "name": "created_at", "in": "query", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "schema": { "type": "string" } }, { "name": "name", "in": "query", "schema": { "type": "string" } }, { "name": "description", "in": "query", "schema": { "type": "string" } }, { "name": "color", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, "description": "tag", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } } }, "description": "The updated Tag object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "tag", "summary": "Update Tag", "description": "Update an existing tag" } }, "/custom_entity": { "get": { "tags": ["Custom Entity"], "parameters": [ { "name": "id", "in": "query", "description": "Entity ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "custom_entity_definition_id", "in": "query", "description": "Custom entity definition ID", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "data", "in": "query", "description": "Entity data matching the custom entity definition schema", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `created_at`, `updated_at`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/custom_entity" } } } } } }, "summary": "List Custom Entitys", "description": "Retrieve a list of custom entitys" }, "post": { "tags": ["Custom Entity"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Entity ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "custom_entity_definition_id": { "type": "string", "description": "Custom entity definition ID", "format": "uuid" }, "contact_id": { "type": "string", "description": "Contact ID", "format": "uuid" }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "data": { "type": "object", "description": "Entity data matching the custom entity definition schema", "format": "jsonb" }, "custom_entity_definition_key": { "format": "text", "type": "string", "description": "Key of the custom entity definition. Alternative to custom_entity_definition_id." } } } } }, "description": "custom_entity", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_entity" } } }, "description": "The updated Custom Entity object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Custom Entity", "$ref": "#/components/schemas/custom_entity" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Custom Entity was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "custom_entity", "summary": "Create Custom Entity", "description": "Create a new custom entity" }, "delete": { "tags": ["Custom Entity"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Entity ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "custom_entity_definition_id", "in": "query", "description": "Custom entity definition ID", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "data", "in": "query", "description": "Entity data matching the custom entity definition schema", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_entity" } } }, "description": "The updated Custom Entity object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Custom Entity", "description": "Delete an existing custom entity" }, "patch": { "tags": ["Custom Entity"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Entity ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "custom_entity_definition_id", "in": "query", "description": "Custom entity definition ID", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "data", "in": "query", "description": "Entity data matching the custom entity definition schema", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Entity ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "custom_entity_definition_id": { "type": "string", "description": "Custom entity definition ID", "format": "uuid" }, "contact_id": { "type": "string", "description": "Contact ID", "format": "uuid" }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "data": { "type": "object", "description": "Entity data matching the custom entity definition schema", "format": "jsonb" }, "custom_entity_definition_key": { "format": "text", "type": "string", "description": "Key of the custom entity definition. Alternative to custom_entity_definition_id." } } } } }, "description": "custom_entity", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_entity" } } }, "description": "The updated Custom Entity object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "custom_entity", "summary": "Update Custom Entity", "description": "Update an existing custom entity" } }, "/appointment_type": { "get": { "tags": ["Appointment Type"], "parameters": [ { "name": "id", "in": "query", "description": "Appointment type ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the appointment type", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Key of the appointment type", "schema": { "type": "string" } }, { "name": "emoji", "in": "query", "description": "Emoji of the appointment type", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Description of the appointment type", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/appointment_type" } } } } } }, "summary": "List Appointment Types", "description": "Retrieve a list of appointment types" }, "post": { "tags": ["Appointment Type"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appointment_type" } } }, "description": "appointment_type", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appointment_type" } } }, "description": "The updated Appointment Type object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Appointment Type", "$ref": "#/components/schemas/appointment_type" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Appointment Type was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "appointment_type", "summary": "Create Appointment Type", "description": "Create a new appointment type" }, "delete": { "tags": ["Appointment Type"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Appointment type ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the appointment type", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Key of the appointment type", "schema": { "type": "string" } }, { "name": "emoji", "in": "query", "description": "Emoji of the appointment type", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Description of the appointment type", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appointment_type" } } }, "description": "The updated Appointment Type object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Appointment Type", "description": "Delete an existing appointment type" }, "patch": { "tags": ["Appointment Type"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Appointment type ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the appointment type", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Key of the appointment type", "schema": { "type": "string" } }, { "name": "emoji", "in": "query", "description": "Emoji of the appointment type", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Description of the appointment type", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appointment_type" } } }, "description": "appointment_type", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appointment_type" } } }, "description": "The updated Appointment Type object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "appointment_type", "summary": "Update Appointment Type", "description": "Update an existing appointment type" } }, "/deal_custom_field": { "get": { "tags": ["Deal Custom Field"], "parameters": [ { "name": "deal_id", "in": "query", "description": "Deal ID", "schema": { "type": "string" } }, { "name": "custom_field_id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Deal custom field creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Deal custom field key", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value of deal custom field", "schema": { "type": "string" } }, { "name": "date_value", "in": "query", "description": "Date value", "schema": { "type": "string" } }, { "name": "string_value", "in": "query", "description": "String value", "schema": { "type": "string" } }, { "name": "number_value", "in": "query", "description": "Number value", "schema": { "type": "string" } }, { "name": "boolean_value", "in": "query", "description": "Boolean value", "schema": { "type": "string" } }, { "name": "datetime_value", "in": "query", "description": "Datetime value", "schema": { "type": "string" } }, { "name": "string_list_value", "in": "query", "description": "String list value", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/deal_custom_field" } } } } } }, "summary": "List Deal Custom Fields", "description": "Retrieve a list of deal custom fields" }, "post": { "tags": ["Deal Custom Field"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal_custom_field" } } }, "description": "deal_custom_field", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal_custom_field" } } }, "description": "The updated Deal Custom Field object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Deal Custom Field", "$ref": "#/components/schemas/deal_custom_field" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Deal Custom Field was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "deal_custom_field", "summary": "Create Deal Custom Field", "description": "Create a new deal custom field" }, "delete": { "tags": ["Deal Custom Field"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "deal_id", "in": "query", "description": "Deal ID", "schema": { "type": "string" } }, { "name": "custom_field_id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Deal custom field creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Deal custom field key", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value of deal custom field", "schema": { "type": "string" } }, { "name": "date_value", "in": "query", "description": "Date value", "schema": { "type": "string" } }, { "name": "string_value", "in": "query", "description": "String value", "schema": { "type": "string" } }, { "name": "number_value", "in": "query", "description": "Number value", "schema": { "type": "string" } }, { "name": "boolean_value", "in": "query", "description": "Boolean value", "schema": { "type": "string" } }, { "name": "datetime_value", "in": "query", "description": "Datetime value", "schema": { "type": "string" } }, { "name": "string_list_value", "in": "query", "description": "String list value", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal_custom_field" } } }, "description": "The updated Deal Custom Field object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Deal Custom Field", "description": "Delete an existing deal custom field" }, "patch": { "tags": ["Deal Custom Field"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "deal_id", "in": "query", "description": "Deal ID", "schema": { "type": "string" } }, { "name": "custom_field_id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Deal custom field creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Deal custom field key", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value of deal custom field", "schema": { "type": "string" } }, { "name": "date_value", "in": "query", "description": "Date value", "schema": { "type": "string" } }, { "name": "string_value", "in": "query", "description": "String value", "schema": { "type": "string" } }, { "name": "number_value", "in": "query", "description": "Number value", "schema": { "type": "string" } }, { "name": "boolean_value", "in": "query", "description": "Boolean value", "schema": { "type": "string" } }, { "name": "datetime_value", "in": "query", "description": "Datetime value", "schema": { "type": "string" } }, { "name": "string_list_value", "in": "query", "description": "String list value", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal_custom_field" } } }, "description": "deal_custom_field", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal_custom_field" } } }, "description": "The updated Deal Custom Field object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "deal_custom_field", "summary": "Update Deal Custom Field", "description": "Update an existing deal custom field" } }, "/review_channel": { "get": { "tags": ["Review Channel"], "parameters": [ { "name": "id", "in": "query", "description": "Review channel ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Review channel creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of review channel", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type of review channel", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/review_channel" } } } } } }, "summary": "List Review Channels", "description": "Retrieve a list of review channels" } }, "/contact_list_contact": { "get": { "tags": ["Contact List Contact"], "parameters": [ { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "contact_list_id", "in": "query", "description": "Contact List ID", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/contact_list_contact" } } } } } }, "summary": "List Contact List Contacts", "description": "Retrieve a list of contact list contacts" }, "post": { "tags": ["Contact List Contact"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_list_contact" } } }, "description": "contact_list_contact", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_list_contact" } } }, "description": "The updated Contact List Contact object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Contact List Contact", "$ref": "#/components/schemas/contact_list_contact" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Contact List Contact was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "contact_list_contact", "summary": "Create Contact List Contact", "description": "Create a new contact list contact" }, "delete": { "tags": ["Contact List Contact"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" }, "required": true }, { "name": "contact_list_id", "in": "query", "description": "Contact List ID", "schema": { "type": "string" }, "required": true }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_list_contact" } } }, "description": "The updated Contact List Contact object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Contact List Contact", "description": "Delete an existing contact list contact" } }, "/contact_note": { "get": { "tags": ["Contact Note"], "parameters": [ { "name": "id", "in": "query", "description": "Contact note ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Contact note creation date", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "text", "in": "query", "description": "Text of contact note", "schema": { "type": "string" } }, { "name": "created_by_id", "in": "query", "description": "Contact note created by ID", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/contact_note" } } } } } }, "summary": "List Contact Notes", "description": "Retrieve a list of contact notes" }, "post": { "tags": ["Contact Note"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_note" } } }, "description": "contact_note", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_note" } } }, "description": "The updated Contact Note object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Contact Note", "$ref": "#/components/schemas/contact_note" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Contact Note was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "contact_note", "summary": "Create Contact Note", "description": "Create a new contact note" }, "delete": { "tags": ["Contact Note"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Contact note ID", "schema": { "type": "string" }, "required": true }, { "name": "created_at", "in": "query", "description": "Contact note creation date", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "text", "in": "query", "description": "Text of contact note", "schema": { "type": "string" } }, { "name": "created_by_id", "in": "query", "description": "Contact note created by ID", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_note" } } }, "description": "The updated Contact Note object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Contact Note", "description": "Delete an existing contact note" }, "patch": { "tags": ["Contact Note"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Contact note ID", "schema": { "type": "string" }, "required": true }, { "name": "created_at", "in": "query", "description": "Contact note creation date", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "text", "in": "query", "description": "Text of contact note", "schema": { "type": "string" } }, { "name": "created_by_id", "in": "query", "description": "Contact note created by ID", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_note" } } }, "description": "contact_note", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_note" } } }, "description": "The updated Contact Note object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "contact_note", "summary": "Update Contact Note", "description": "Update an existing contact note" } }, "/template": { "get": { "tags": ["Template"], "parameters": [ { "name": "id", "in": "query", "description": "Template ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Template creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of template", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Subject of template", "schema": { "type": "string" } }, { "name": "content", "in": "query", "description": "Content of template", "schema": { "type": "string" } }, { "name": "text", "in": "query", "description": "Text representation of the template content", "schema": { "type": "string" } }, { "name": "request_approvals", "in": "query", "description": "Request approvals of template", "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language of template", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Template key", "schema": { "type": "string" } }, { "name": "footer", "in": "query", "description": "Footer of template", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type of template", "schema": { "type": "string" } }, { "name": "buttons", "in": "query", "description": "Buttons of template", "schema": { "type": "string" } }, { "name": "header_media_filename", "in": "query", "description": "Header media filename of template", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `name`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/template" } } } } } }, "summary": "List Templates", "description": "Retrieve a list of templates" }, "post": { "tags": ["Template"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Template ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Template creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid", "nullable": true }, "name": { "type": "string", "description": "Name of template", "format": "text" }, "subject": { "type": "string", "description": "Subject of template", "format": "text", "nullable": true }, "content": { "type": "object", "description": "Content of template", "format": "jsonb", "nullable": true }, "text": { "format": "text", "type": "string", "description": "Text content for the template." }, "request_approvals": { "type": "boolean", "description": "Request approvals of template", "format": "boolean", "nullable": true }, "language": { "maxLength": 2, "type": "string", "description": "Language of template", "format": "character varying" }, "key": { "type": "string", "description": "Template key", "format": "text" }, "footer": { "type": "string", "description": "Footer of template", "format": "text", "nullable": true }, "type": { "type": "string", "description": "Type of template", "format": "public.template_type", "enum": [ "review_request", "auto_responder", "opt_in_request", "transactional", "marketing", "opt_out_confirmation", "double_opt_in_confirmation" ] }, "buttons": { "type": "object", "description": "Buttons of template", "format": "jsonb", "nullable": true }, "header_media_filename": { "type": "string", "description": "Header media filename of template", "format": "text", "nullable": true }, "header_media": { "format": "text", "type": "string", "description": "URL to the header media for the template. Can be https:// or media_library://" }, "html": { "format": "text", "type": "string", "description": "HTML content for the template." } } } } }, "description": "template", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/template" } } }, "description": "The updated Template object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Template", "$ref": "#/components/schemas/template" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Template was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "template", "summary": "Create Template", "description": "Create a new template" }, "delete": { "tags": ["Template"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Template ID", "schema": { "type": "string" }, "required": true }, { "name": "created_at", "in": "query", "description": "Template creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of template", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Subject of template", "schema": { "type": "string" } }, { "name": "content", "in": "query", "description": "Content of template", "schema": { "type": "string" } }, { "name": "text", "in": "query", "description": "Text representation of the template content", "schema": { "type": "string" } }, { "name": "request_approvals", "in": "query", "description": "Request approvals of template", "schema": { "type": "string" } }, { "name": "language", "in": "query", "description": "Language of template", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Template key", "schema": { "type": "string" } }, { "name": "footer", "in": "query", "description": "Footer of template", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type of template", "schema": { "type": "string" } }, { "name": "buttons", "in": "query", "description": "Buttons of template", "schema": { "type": "string" } }, { "name": "header_media_filename", "in": "query", "description": "Header media filename of template", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/template" } } }, "description": "The updated Template object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Template", "description": "Delete an existing template" } }, "/deal_status": { "get": { "tags": ["Deal Status"], "parameters": [ { "name": "id", "in": "query", "description": "Deal status ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "deal_type_id", "in": "query", "description": "Deal type ID", "schema": { "type": "string" } }, { "name": "idx", "in": "query", "description": "Index of the deal", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the deal", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type of the deal", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Key of the deal", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/deal_status" } } } } } }, "summary": "List Deal Status", "description": "Retrieve a list of deal status" } }, "/message_action": { "get": { "tags": ["Message Action"], "parameters": [ { "name": "id", "in": "query", "description": "Message action ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Message action creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "conversation_id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" } }, { "name": "message_id", "in": "query", "description": "Message ID", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type of message action", "schema": { "type": "string" } }, { "name": "subtype", "in": "query", "description": "Subtype of message", "schema": { "type": "string" } }, { "name": "text", "in": "query", "description": "Text of message action", "schema": { "type": "string" } }, { "name": "data", "in": "query", "description": "Data of message action", "schema": { "type": "string" } }, { "name": "clicked", "in": "query", "description": "Is message action clicked?", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `updated_at`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/message_action" } } } } } }, "summary": "List Message Actions", "description": "Retrieve a list of message actions" } }, "/journey_version": { "get": { "tags": ["Journey Version"], "parameters": [ { "name": "id", "in": "query", "description": "Journey version ID", "schema": { "type": "string" } }, { "name": "journey_id", "in": "query", "description": "Journey ID", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "published", "in": "query", "description": "Whether this version is published", "schema": { "type": "string" } }, { "name": "version", "in": "query", "description": "Version number", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `version`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/journey_version" } } } } } }, "summary": "List Journey Versions", "description": "Retrieve a list of journey versions" } }, "/conversation_tag": { "get": { "tags": ["Conversation Tag"], "parameters": [ { "name": "created_at", "in": "query", "description": "Conversation creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "tag_id", "in": "query", "description": "Tag ID", "schema": { "type": "string" } }, { "name": "conversation_id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/conversation_tag" } } } } } }, "summary": "List Conversation Tags", "description": "Retrieve a list of conversation tags" }, "post": { "tags": ["Conversation Tag"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversation_tag" } } }, "description": "conversation_tag", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversation_tag" } } }, "description": "The updated Conversation Tag object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Conversation Tag", "$ref": "#/components/schemas/conversation_tag" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Conversation Tag was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "conversation_tag", "summary": "Create Conversation Tag", "description": "Create a new conversation tag" }, "delete": { "tags": ["Conversation Tag"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Conversation creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "tag_id", "in": "query", "description": "Tag ID", "schema": { "type": "string" }, "required": true }, { "name": "conversation_id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" }, "required": true } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversation_tag" } } }, "description": "The updated Conversation Tag object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Conversation Tag", "description": "Delete an existing conversation tag" }, "patch": { "tags": ["Conversation Tag"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Conversation creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "tag_id", "in": "query", "description": "Tag ID", "schema": { "type": "string" }, "required": true }, { "name": "conversation_id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" }, "required": true } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversation_tag" } } }, "description": "conversation_tag", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversation_tag" } } }, "description": "The updated Conversation Tag object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "conversation_tag", "summary": "Update Conversation Tag", "description": "Update an existing conversation tag" } }, "/contact": { "get": { "tags": ["Contact"], "parameters": [ { "name": "id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Contact creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "full_name", "in": "query", "description": "Name of contact", "schema": { "type": "string" } }, { "name": "fts", "in": "query", "description": "Handle of contact", "schema": { "type": "string" } }, { "name": "is_blocked", "in": "query", "description": "Is the contact blocked?", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "secondary_external_id", "in": "query", "description": "Secondary External ID", "schema": { "type": "string" } }, { "name": "birthday", "in": "query", "description": "Birthday of the contact", "schema": { "type": "string" } }, { "name": "salutation", "in": "query", "description": "Salutation", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email of contact", "schema": { "type": "string" } }, { "name": "sms", "in": "query", "description": "SMS of contact", "schema": { "type": "string" } }, { "name": "whatsapp", "in": "query", "description": "Whatsapp Number", "schema": { "type": "string" } }, { "name": "instagram", "in": "query", "description": "Instagram", "schema": { "type": "string" } }, { "name": "facebook", "in": "query", "description": "Facebook", "schema": { "type": "string" } }, { "name": "display_name", "in": "query", "description": "Displayed name of contact in the Mateo app", "schema": { "type": "string" } }, { "name": "google_business_messaging", "in": "query", "description": "Google business messaging account of contact", "schema": { "type": "string" } }, { "name": "address_line1", "in": "query", "description": "First line of the postal address", "schema": { "type": "string" } }, { "name": "address_line2", "in": "query", "description": "Second line of the postal address", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "City of the postal address", "schema": { "type": "string" } }, { "name": "zipcode", "in": "query", "description": "Postal code or ZIP code of the address", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Country of the postal address", "schema": { "type": "string" } }, { "name": "postal", "in": "query", "description": "Postal handle or identifier for the contact", "schema": { "type": "string" } }, { "name": "number_of_marketing_opt_in_requests", "in": "query", "description": "Number of marketing opt in requests", "schema": { "type": "string" } }, { "name": "latest_marketing_opt_in_request_sent_at", "in": "query", "description": "Latest marketing opt in request sent at", "schema": { "type": "string" } }, { "name": "campaign_messages_this_month", "in": "query", "description": "Campaign Messages this month", "schema": { "type": "string" } }, { "name": "whatsapp_marketing_opt_in", "in": "query", "description": "WhatsApp marketign opt in", "schema": { "type": "string" } }, { "name": "sms_marketing_opt_in", "in": "query", "description": "SMS marketing opt in", "schema": { "type": "string" } }, { "name": "email_marketing_opt_in", "in": "query", "description": "Email marketing opt in of contact", "schema": { "type": "string" } }, { "name": "facebook_marketing_opt_in", "in": "query", "description": "Facebook marketing opt in", "schema": { "type": "string" } }, { "name": "instagram_marketing_opt_in", "in": "query", "description": "Instagram marketing opt in", "schema": { "type": "string" } }, { "name": "google_business_messaging_marketing_opt_in", "in": "query", "description": "Google business messaging marketing opt in", "schema": { "type": "string" } }, { "name": "postal_marketing_opt_in", "in": "query", "description": "Postal marketing opt in status", "schema": { "type": "string" } }, { "name": "whatsapp_transactional_opt_in", "in": "query", "description": "WhatsApp transactional opt in", "schema": { "type": "string" } }, { "name": "sms_transactional_opt_in", "in": "query", "description": "SMS transactional opt in", "schema": { "type": "string" } }, { "name": "email_transactional_opt_in", "in": "query", "description": "Email transactional opt in", "schema": { "type": "string" } }, { "name": "facebook_transactional_opt_in", "in": "query", "description": "Facebook transactional opt in", "schema": { "type": "string" } }, { "name": "instagram_transactional_opt_in", "in": "query", "description": "Instagram transactional opt in", "schema": { "type": "string" } }, { "name": "google_business_messaging_transactional_opt_in", "in": "query", "description": "Google business messaging transactional opt in", "schema": { "type": "string" } }, { "name": "postal_transactional_opt_in", "in": "query", "description": "Postal transactional opt in status", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `created_at`, `display_name`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/contact" } } } } } }, "summary": "List Contacts", "description": "Retrieve a list of contacts" }, "post": { "tags": ["Contact"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Contact ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Contact creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "full_name": { "type": "string", "description": "Name of contact", "format": "text", "nullable": true }, "fts": { "type": "string", "description": "Handle of contact", "format": "tsvector", "nullable": true }, "is_blocked": { "type": "boolean", "description": "Is the contact blocked?", "format": "boolean", "default": false }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "secondary_external_id": { "type": "string", "description": "Secondary External ID", "format": "text", "nullable": true }, "birthday": { "type": "string", "description": "Birthday of the contact", "format": "date", "nullable": true }, "salutation": { "type": "string", "description": "Salutation", "format": "text", "nullable": true }, "email": { "type": "string", "description": "Email of contact", "format": "text", "nullable": true }, "sms": { "type": "string", "description": "SMS of contact", "format": "text", "nullable": true }, "whatsapp": { "type": "string", "description": "Whatsapp Number", "format": "text", "nullable": true }, "instagram": { "type": "string", "description": "Instagram", "format": "text", "nullable": true }, "facebook": { "type": "string", "description": "Facebook", "format": "text", "nullable": true }, "google_business_messaging": { "type": "string", "description": "Google business messaging account of contact", "format": "text", "nullable": true }, "address_line1": { "type": "string", "description": "First line of the postal address", "format": "text", "nullable": true }, "address_line2": { "type": "string", "description": "Second line of the postal address", "format": "text", "nullable": true }, "city": { "type": "string", "description": "City of the postal address", "format": "text", "nullable": true }, "zipcode": { "type": "string", "description": "Postal code or ZIP code of the address", "format": "text", "nullable": true }, "country": { "type": "string", "description": "Country of the postal address", "format": "text", "nullable": true }, "postal": { "type": "string", "description": "Postal handle or identifier for the contact", "format": "text", "nullable": true }, "number_of_marketing_opt_in_requests": { "type": "integer", "description": "Number of marketing opt in requests", "format": "integer" }, "latest_marketing_opt_in_request_sent_at": { "type": "string", "description": "Latest marketing opt in request sent at", "format": "timestamp with time zone", "nullable": true }, "campaign_messages_this_month": { "type": "integer", "description": "Campaign Messages this month", "format": "integer" }, "whatsapp_marketing_opt_in": { "type": "boolean", "description": "WhatsApp marketign opt in", "format": "boolean", "default": false }, "sms_marketing_opt_in": { "type": "boolean", "description": "SMS marketing opt in", "format": "boolean", "default": false }, "email_marketing_opt_in": { "type": "boolean", "description": "Email marketing opt in of contact", "format": "boolean", "default": false }, "facebook_marketing_opt_in": { "type": "boolean", "description": "Facebook marketing opt in", "format": "boolean", "default": false }, "instagram_marketing_opt_in": { "type": "boolean", "description": "Instagram marketing opt in", "format": "boolean", "default": false }, "google_business_messaging_marketing_opt_in": { "type": "boolean", "description": "Google business messaging marketing opt in", "format": "boolean", "default": false }, "postal_marketing_opt_in": { "type": "boolean", "description": "Postal marketing opt in status", "format": "boolean", "default": true }, "whatsapp_transactional_opt_in": { "type": "string", "description": "WhatsApp transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "sms_transactional_opt_in": { "type": "string", "description": "SMS transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "email_transactional_opt_in": { "type": "string", "description": "Email transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "facebook_transactional_opt_in": { "type": "string", "description": "Facebook transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "instagram_transactional_opt_in": { "type": "string", "description": "Instagram transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "google_business_messaging_transactional_opt_in": { "type": "string", "description": "Google business messaging transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "postal_transactional_opt_in": { "type": "string", "description": "Postal transactional opt in status", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true } } } } }, "description": "contact", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact" } } }, "description": "The updated Contact object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Contact", "$ref": "#/components/schemas/contact" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Contact was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "contact", "summary": "Create Contact", "description": "Create a new contact" }, "delete": { "tags": ["Contact"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Contact creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "full_name", "in": "query", "description": "Name of contact", "schema": { "type": "string" } }, { "name": "fts", "in": "query", "description": "Handle of contact", "schema": { "type": "string" } }, { "name": "is_blocked", "in": "query", "description": "Is the contact blocked?", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "secondary_external_id", "in": "query", "description": "Secondary External ID", "schema": { "type": "string" } }, { "name": "birthday", "in": "query", "description": "Birthday of the contact", "schema": { "type": "string" } }, { "name": "salutation", "in": "query", "description": "Salutation", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email of contact", "schema": { "type": "string" } }, { "name": "sms", "in": "query", "description": "SMS of contact", "schema": { "type": "string" } }, { "name": "whatsapp", "in": "query", "description": "Whatsapp Number", "schema": { "type": "string" } }, { "name": "instagram", "in": "query", "description": "Instagram", "schema": { "type": "string" } }, { "name": "facebook", "in": "query", "description": "Facebook", "schema": { "type": "string" } }, { "name": "display_name", "in": "query", "description": "Displayed name of contact in the Mateo app", "schema": { "type": "string" } }, { "name": "google_business_messaging", "in": "query", "description": "Google business messaging account of contact", "schema": { "type": "string" } }, { "name": "address_line1", "in": "query", "description": "First line of the postal address", "schema": { "type": "string" } }, { "name": "address_line2", "in": "query", "description": "Second line of the postal address", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "City of the postal address", "schema": { "type": "string" } }, { "name": "zipcode", "in": "query", "description": "Postal code or ZIP code of the address", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Country of the postal address", "schema": { "type": "string" } }, { "name": "postal", "in": "query", "description": "Postal handle or identifier for the contact", "schema": { "type": "string" } }, { "name": "number_of_marketing_opt_in_requests", "in": "query", "description": "Number of marketing opt in requests", "schema": { "type": "string" } }, { "name": "latest_marketing_opt_in_request_sent_at", "in": "query", "description": "Latest marketing opt in request sent at", "schema": { "type": "string" } }, { "name": "campaign_messages_this_month", "in": "query", "description": "Campaign Messages this month", "schema": { "type": "string" } }, { "name": "whatsapp_marketing_opt_in", "in": "query", "description": "WhatsApp marketign opt in", "schema": { "type": "string" } }, { "name": "sms_marketing_opt_in", "in": "query", "description": "SMS marketing opt in", "schema": { "type": "string" } }, { "name": "email_marketing_opt_in", "in": "query", "description": "Email marketing opt in of contact", "schema": { "type": "string" } }, { "name": "facebook_marketing_opt_in", "in": "query", "description": "Facebook marketing opt in", "schema": { "type": "string" } }, { "name": "instagram_marketing_opt_in", "in": "query", "description": "Instagram marketing opt in", "schema": { "type": "string" } }, { "name": "google_business_messaging_marketing_opt_in", "in": "query", "description": "Google business messaging marketing opt in", "schema": { "type": "string" } }, { "name": "postal_marketing_opt_in", "in": "query", "description": "Postal marketing opt in status", "schema": { "type": "string" } }, { "name": "whatsapp_transactional_opt_in", "in": "query", "description": "WhatsApp transactional opt in", "schema": { "type": "string" } }, { "name": "sms_transactional_opt_in", "in": "query", "description": "SMS transactional opt in", "schema": { "type": "string" } }, { "name": "email_transactional_opt_in", "in": "query", "description": "Email transactional opt in", "schema": { "type": "string" } }, { "name": "facebook_transactional_opt_in", "in": "query", "description": "Facebook transactional opt in", "schema": { "type": "string" } }, { "name": "instagram_transactional_opt_in", "in": "query", "description": "Instagram transactional opt in", "schema": { "type": "string" } }, { "name": "google_business_messaging_transactional_opt_in", "in": "query", "description": "Google business messaging transactional opt in", "schema": { "type": "string" } }, { "name": "postal_transactional_opt_in", "in": "query", "description": "Postal transactional opt in status", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact" } } }, "description": "The updated Contact object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Contact", "description": "Delete an existing contact" }, "patch": { "tags": ["Contact"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Contact creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "full_name", "in": "query", "description": "Name of contact", "schema": { "type": "string" } }, { "name": "fts", "in": "query", "description": "Handle of contact", "schema": { "type": "string" } }, { "name": "is_blocked", "in": "query", "description": "Is the contact blocked?", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "secondary_external_id", "in": "query", "description": "Secondary External ID", "schema": { "type": "string" } }, { "name": "birthday", "in": "query", "description": "Birthday of the contact", "schema": { "type": "string" } }, { "name": "salutation", "in": "query", "description": "Salutation", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email of contact", "schema": { "type": "string" } }, { "name": "sms", "in": "query", "description": "SMS of contact", "schema": { "type": "string" } }, { "name": "whatsapp", "in": "query", "description": "Whatsapp Number", "schema": { "type": "string" } }, { "name": "instagram", "in": "query", "description": "Instagram", "schema": { "type": "string" } }, { "name": "facebook", "in": "query", "description": "Facebook", "schema": { "type": "string" } }, { "name": "display_name", "in": "query", "description": "Displayed name of contact in the Mateo app", "schema": { "type": "string" } }, { "name": "google_business_messaging", "in": "query", "description": "Google business messaging account of contact", "schema": { "type": "string" } }, { "name": "address_line1", "in": "query", "description": "First line of the postal address", "schema": { "type": "string" } }, { "name": "address_line2", "in": "query", "description": "Second line of the postal address", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "City of the postal address", "schema": { "type": "string" } }, { "name": "zipcode", "in": "query", "description": "Postal code or ZIP code of the address", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Country of the postal address", "schema": { "type": "string" } }, { "name": "postal", "in": "query", "description": "Postal handle or identifier for the contact", "schema": { "type": "string" } }, { "name": "number_of_marketing_opt_in_requests", "in": "query", "description": "Number of marketing opt in requests", "schema": { "type": "string" } }, { "name": "latest_marketing_opt_in_request_sent_at", "in": "query", "description": "Latest marketing opt in request sent at", "schema": { "type": "string" } }, { "name": "campaign_messages_this_month", "in": "query", "description": "Campaign Messages this month", "schema": { "type": "string" } }, { "name": "whatsapp_marketing_opt_in", "in": "query", "description": "WhatsApp marketign opt in", "schema": { "type": "string" } }, { "name": "sms_marketing_opt_in", "in": "query", "description": "SMS marketing opt in", "schema": { "type": "string" } }, { "name": "email_marketing_opt_in", "in": "query", "description": "Email marketing opt in of contact", "schema": { "type": "string" } }, { "name": "facebook_marketing_opt_in", "in": "query", "description": "Facebook marketing opt in", "schema": { "type": "string" } }, { "name": "instagram_marketing_opt_in", "in": "query", "description": "Instagram marketing opt in", "schema": { "type": "string" } }, { "name": "google_business_messaging_marketing_opt_in", "in": "query", "description": "Google business messaging marketing opt in", "schema": { "type": "string" } }, { "name": "postal_marketing_opt_in", "in": "query", "description": "Postal marketing opt in status", "schema": { "type": "string" } }, { "name": "whatsapp_transactional_opt_in", "in": "query", "description": "WhatsApp transactional opt in", "schema": { "type": "string" } }, { "name": "sms_transactional_opt_in", "in": "query", "description": "SMS transactional opt in", "schema": { "type": "string" } }, { "name": "email_transactional_opt_in", "in": "query", "description": "Email transactional opt in", "schema": { "type": "string" } }, { "name": "facebook_transactional_opt_in", "in": "query", "description": "Facebook transactional opt in", "schema": { "type": "string" } }, { "name": "instagram_transactional_opt_in", "in": "query", "description": "Instagram transactional opt in", "schema": { "type": "string" } }, { "name": "google_business_messaging_transactional_opt_in", "in": "query", "description": "Google business messaging transactional opt in", "schema": { "type": "string" } }, { "name": "postal_transactional_opt_in", "in": "query", "description": "Postal transactional opt in status", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Contact ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Contact creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "full_name": { "type": "string", "description": "Name of contact", "format": "text", "nullable": true }, "fts": { "type": "string", "description": "Handle of contact", "format": "tsvector", "nullable": true }, "is_blocked": { "type": "boolean", "description": "Is the contact blocked?", "format": "boolean", "default": false }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "secondary_external_id": { "type": "string", "description": "Secondary External ID", "format": "text", "nullable": true }, "birthday": { "type": "string", "description": "Birthday of the contact", "format": "date", "nullable": true }, "salutation": { "type": "string", "description": "Salutation", "format": "text", "nullable": true }, "email": { "type": "string", "description": "Email of contact", "format": "text", "nullable": true }, "sms": { "type": "string", "description": "SMS of contact", "format": "text", "nullable": true }, "whatsapp": { "type": "string", "description": "Whatsapp Number", "format": "text", "nullable": true }, "instagram": { "type": "string", "description": "Instagram", "format": "text", "nullable": true }, "facebook": { "type": "string", "description": "Facebook", "format": "text", "nullable": true }, "google_business_messaging": { "type": "string", "description": "Google business messaging account of contact", "format": "text", "nullable": true }, "address_line1": { "type": "string", "description": "First line of the postal address", "format": "text", "nullable": true }, "address_line2": { "type": "string", "description": "Second line of the postal address", "format": "text", "nullable": true }, "city": { "type": "string", "description": "City of the postal address", "format": "text", "nullable": true }, "zipcode": { "type": "string", "description": "Postal code or ZIP code of the address", "format": "text", "nullable": true }, "country": { "type": "string", "description": "Country of the postal address", "format": "text", "nullable": true }, "postal": { "type": "string", "description": "Postal handle or identifier for the contact", "format": "text", "nullable": true }, "number_of_marketing_opt_in_requests": { "type": "integer", "description": "Number of marketing opt in requests", "format": "integer" }, "latest_marketing_opt_in_request_sent_at": { "type": "string", "description": "Latest marketing opt in request sent at", "format": "timestamp with time zone", "nullable": true }, "campaign_messages_this_month": { "type": "integer", "description": "Campaign Messages this month", "format": "integer" }, "whatsapp_marketing_opt_in": { "type": "boolean", "description": "WhatsApp marketign opt in", "format": "boolean", "default": false }, "sms_marketing_opt_in": { "type": "boolean", "description": "SMS marketing opt in", "format": "boolean", "default": false }, "email_marketing_opt_in": { "type": "boolean", "description": "Email marketing opt in of contact", "format": "boolean", "default": false }, "facebook_marketing_opt_in": { "type": "boolean", "description": "Facebook marketing opt in", "format": "boolean", "default": false }, "instagram_marketing_opt_in": { "type": "boolean", "description": "Instagram marketing opt in", "format": "boolean", "default": false }, "google_business_messaging_marketing_opt_in": { "type": "boolean", "description": "Google business messaging marketing opt in", "format": "boolean", "default": false }, "postal_marketing_opt_in": { "type": "boolean", "description": "Postal marketing opt in status", "format": "boolean", "default": true }, "whatsapp_transactional_opt_in": { "type": "string", "description": "WhatsApp transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "sms_transactional_opt_in": { "type": "string", "description": "SMS transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "email_transactional_opt_in": { "type": "string", "description": "Email transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "facebook_transactional_opt_in": { "type": "string", "description": "Facebook transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "instagram_transactional_opt_in": { "type": "string", "description": "Instagram transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "google_business_messaging_transactional_opt_in": { "type": "string", "description": "Google business messaging transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "postal_transactional_opt_in": { "type": "string", "description": "Postal transactional opt in status", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true } } } } }, "description": "contact", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact" } } }, "description": "The updated Contact object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "contact", "summary": "Update Contact", "description": "Update an existing contact" } }, "/conversation": { "get": { "tags": ["Conversation"], "parameters": [ { "name": "id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Conversation creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Subject of conversation", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status of conversation", "schema": { "type": "string" } }, { "name": "assignee_id", "in": "query", "description": "Assignee ID", "schema": { "type": "string" } }, { "name": "unread", "in": "query", "description": "Is conversation on unread?", "schema": { "type": "string" } }, { "name": "channel_id", "in": "query", "description": "Channel ID", "schema": { "type": "string" } }, { "name": "channel_type", "in": "query", "description": "Channel Type of Conversation", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "tags", "in": "query", "description": "Given tags of conversation", "schema": { "type": "string" } }, { "name": "is_spam", "in": "query", "description": "Is conversation marked as spam?", "schema": { "type": "string" } }, { "name": "inbox_id", "in": "query", "description": "Inbox ID", "schema": { "type": "string" } }, { "name": "latest_message_id", "in": "query", "description": "Latest message ID", "schema": { "type": "string" } }, { "name": "latest_inbound_message_id", "in": "query", "description": "Latest inbound message ID", "schema": { "type": "string" } }, { "name": "latest_message_created_at", "in": "query", "description": "Latest message creation date", "schema": { "type": "string" } }, { "name": "latest_inbound_message_created_at", "in": "query", "description": "Latest inbound message creation date", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `latest_activity_created_at`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/conversation" } } } } } }, "summary": "List Conversations", "description": "Retrieve a list of conversations" }, "patch": { "tags": ["Conversation"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" }, "required": true }, { "name": "created_at", "in": "query", "description": "Conversation creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "subject", "in": "query", "description": "Subject of conversation", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status of conversation", "schema": { "type": "string" } }, { "name": "assignee_id", "in": "query", "description": "Assignee ID", "schema": { "type": "string" } }, { "name": "unread", "in": "query", "description": "Is conversation on unread?", "schema": { "type": "string" } }, { "name": "channel_id", "in": "query", "description": "Channel ID", "schema": { "type": "string" } }, { "name": "channel_type", "in": "query", "description": "Channel Type of Conversation", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "tags", "in": "query", "description": "Given tags of conversation", "schema": { "type": "string" } }, { "name": "is_spam", "in": "query", "description": "Is conversation marked as spam?", "schema": { "type": "string" } }, { "name": "inbox_id", "in": "query", "description": "Inbox ID", "schema": { "type": "string" } }, { "name": "latest_message_id", "in": "query", "description": "Latest message ID", "schema": { "type": "string" } }, { "name": "latest_inbound_message_id", "in": "query", "description": "Latest inbound message ID", "schema": { "type": "string" } }, { "name": "latest_message_created_at", "in": "query", "description": "Latest message creation date", "schema": { "type": "string" } }, { "name": "latest_inbound_message_created_at", "in": "query", "description": "Latest inbound message creation date", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "inbox_id": { "type": "string", "description": "Inbox ID", "format": "uuid" }, "assignee_id": { "type": "string", "description": "Assignee ID", "format": "uuid", "nullable": true }, "status": { "type": "string", "description": "Status of conversation", "format": "public.conversation_status", "enum": ["open", "closed", "archived"], "default": "open" } } } } }, "description": "conversation", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversation" } } }, "description": "The updated Conversation object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "conversation", "summary": "Update Conversation", "description": "Update an existing conversation" } }, "/journey": { "get": { "tags": ["Journey"], "parameters": [ { "name": "id", "in": "query", "description": "Journey ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Journey name", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Journey key", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Journey status", "schema": { "type": "string" } }, { "name": "latest_published_version_id", "in": "query", "description": "Latest published version ID", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/journey" } } } } } }, "summary": "List Journeys", "description": "Retrieve a list of journeys" } }, "/recipient": { "get": { "tags": ["Recipient"], "parameters": [ { "name": "id", "in": "query", "description": "Recipient ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Recipient creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "conversation_id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" } }, { "name": "message_id", "in": "query", "description": "Message ID", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "handle", "in": "query", "description": "Handle of recipient", "schema": { "type": "string" } }, { "name": "full_name", "in": "query", "description": "Name of recipient", "schema": { "type": "string" } }, { "name": "role", "in": "query", "description": "Role of recipient", "schema": { "type": "string" } }, { "name": "is_organisation", "in": "query", "description": "Is recipient the organisation?", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status of recipient", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `created_at`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/recipient" } } } } } }, "summary": "List Recipients", "description": "Retrieve a list of recipients" } }, "/custom_entity_definition": { "get": { "tags": ["Custom Entity Definition"], "parameters": [ { "name": "id", "in": "query", "description": "Custom entity definition ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Unique key for the custom entity definition", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the custom entity definition", "schema": { "type": "string" } }, { "name": "schema", "in": "query", "description": "JSON Schema defining the custom entity data structure", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `created_at`, `updated_at`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/custom_entity_definition" } } } } } }, "summary": "List Custom Entity Definitions", "description": "Retrieve a list of custom entity definitions" }, "post": { "tags": ["Custom Entity Definition"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_entity_definition" } } }, "description": "custom_entity_definition", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_entity_definition" } } }, "description": "The updated Custom Entity Definition object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Custom Entity Definition", "$ref": "#/components/schemas/custom_entity_definition" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Custom Entity Definition was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "custom_entity_definition", "summary": "Create Custom Entity Definition", "description": "Create a new custom entity definition" }, "delete": { "tags": ["Custom Entity Definition"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Custom entity definition ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Unique key for the custom entity definition", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the custom entity definition", "schema": { "type": "string" } }, { "name": "schema", "in": "query", "description": "JSON Schema defining the custom entity data structure", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_entity_definition" } } }, "description": "The updated Custom Entity Definition object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Custom Entity Definition", "description": "Delete an existing custom entity definition" }, "patch": { "tags": ["Custom Entity Definition"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Custom entity definition ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Unique key for the custom entity definition", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the custom entity definition", "schema": { "type": "string" } }, { "name": "schema", "in": "query", "description": "JSON Schema defining the custom entity data structure", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_entity_definition" } } }, "description": "custom_entity_definition", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_entity_definition" } } }, "description": "The updated Custom Entity Definition object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "custom_entity_definition", "summary": "Update Custom Entity Definition", "description": "Update an existing custom entity definition" } }, "/contact_list": { "get": { "tags": ["Contact List"], "parameters": [ { "name": "id", "in": "query", "description": "Contact List ID", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of contact list", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/contact_list" } } } } } }, "summary": "List Contact Lists", "description": "Retrieve a list of contact lists" }, "post": { "tags": ["Contact List"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_list" } } }, "description": "contact_list", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_list" } } }, "description": "The updated Contact List object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Contact List", "$ref": "#/components/schemas/contact_list" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Contact List was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "contact_list", "summary": "Create Contact List", "description": "Create a new contact list" }, "delete": { "tags": ["Contact List"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Contact List ID", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of contact list", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_list" } } }, "description": "The updated Contact List object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Contact List", "description": "Delete an existing contact list" }, "patch": { "tags": ["Contact List"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Contact List ID", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of contact list", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_list" } } }, "description": "contact_list", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_list" } } }, "description": "The updated Contact List object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "contact_list", "summary": "Update Contact List", "description": "Update an existing contact list" } }, "/location": { "get": { "tags": ["Location"], "parameters": [ { "name": "id", "in": "query", "description": "Location ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the location", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "street", "in": "query", "description": "Street address", "schema": { "type": "string" } }, { "name": "postal_code", "in": "query", "description": "Postal or ZIP code", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "City", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Region or state", "schema": { "type": "string" } }, { "name": "iso_country", "in": "query", "description": "ISO 3166-1 alpha-2 country code", "schema": { "type": "string" } }, { "name": "address_line", "in": "query", "description": "Full formatted address line (generated)", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `created_at`, `updated_at`, `name`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/location" } } } } } }, "summary": "List Locations", "description": "Retrieve a list of locations" }, "post": { "tags": ["Location"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/location" } } }, "description": "location", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/location" } } }, "description": "The updated Location object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Location", "$ref": "#/components/schemas/location" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Location was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "location", "summary": "Create Location", "description": "Create a new location" }, "delete": { "tags": ["Location"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Location ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the location", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "street", "in": "query", "description": "Street address", "schema": { "type": "string" } }, { "name": "postal_code", "in": "query", "description": "Postal or ZIP code", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "City", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Region or state", "schema": { "type": "string" } }, { "name": "iso_country", "in": "query", "description": "ISO 3166-1 alpha-2 country code", "schema": { "type": "string" } }, { "name": "address_line", "in": "query", "description": "Full formatted address line (generated)", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/location" } } }, "description": "The updated Location object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Location", "description": "Delete an existing location" }, "patch": { "tags": ["Location"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Location ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the location", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "street", "in": "query", "description": "Street address", "schema": { "type": "string" } }, { "name": "postal_code", "in": "query", "description": "Postal or ZIP code", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "City", "schema": { "type": "string" } }, { "name": "region", "in": "query", "description": "Region or state", "schema": { "type": "string" } }, { "name": "iso_country", "in": "query", "description": "ISO 3166-1 alpha-2 country code", "schema": { "type": "string" } }, { "name": "address_line", "in": "query", "description": "Full formatted address line (generated)", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/location" } } }, "description": "location", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/location" } } }, "description": "The updated Location object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "location", "summary": "Update Location", "description": "Update an existing location" } }, "/webhook": { "get": { "tags": ["Webhook"], "parameters": [ { "name": "id", "in": "query", "description": "Webhook ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Webhook creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of webhook", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Source of webhook", "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Is the webhook active?", "schema": { "type": "string" } }, { "name": "target_url", "in": "query", "description": "Target url of webhook", "schema": { "type": "string" } }, { "name": "headers", "in": "query", "description": "Header of webhook", "schema": { "type": "string" } }, { "name": "method", "in": "query", "description": "Webhook method", "schema": { "type": "string" } }, { "name": "event", "in": "query", "description": "Event of webhook", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `name`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/webhook" } } } } } }, "summary": "List Webhooks", "description": "Retrieve a list of webhooks" }, "post": { "tags": ["Webhook"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, "description": "webhook", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, "description": "The updated Webhook object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Webhook", "$ref": "#/components/schemas/webhook" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Webhook was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "webhook", "summary": "Create Webhook", "description": "Create a new webhook" }, "delete": { "tags": ["Webhook"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Webhook ID", "schema": { "type": "string" }, "required": true }, { "name": "created_at", "in": "query", "description": "Webhook creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of webhook", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Source of webhook", "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Is the webhook active?", "schema": { "type": "string" } }, { "name": "target_url", "in": "query", "description": "Target url of webhook", "schema": { "type": "string" } }, { "name": "headers", "in": "query", "description": "Header of webhook", "schema": { "type": "string" } }, { "name": "method", "in": "query", "description": "Webhook method", "schema": { "type": "string" } }, { "name": "event", "in": "query", "description": "Event of webhook", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, "description": "The updated Webhook object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Webhook", "description": "Delete an existing webhook" }, "patch": { "tags": ["Webhook"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Webhook ID", "schema": { "type": "string" }, "required": true }, { "name": "created_at", "in": "query", "description": "Webhook creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of webhook", "schema": { "type": "string" } }, { "name": "source", "in": "query", "description": "Source of webhook", "schema": { "type": "string" } }, { "name": "active", "in": "query", "description": "Is the webhook active?", "schema": { "type": "string" } }, { "name": "target_url", "in": "query", "description": "Target url of webhook", "schema": { "type": "string" } }, { "name": "headers", "in": "query", "description": "Header of webhook", "schema": { "type": "string" } }, { "name": "method", "in": "query", "description": "Webhook method", "schema": { "type": "string" } }, { "name": "event", "in": "query", "description": "Event of webhook", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, "description": "webhook", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } } }, "description": "The updated Webhook object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "webhook", "summary": "Update Webhook", "description": "Update an existing webhook" } }, "/comment": { "get": { "tags": ["Comment"], "parameters": [ { "name": "id", "in": "query", "description": "Comment ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Comment creation date", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "conversation_id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" } }, { "name": "message_id", "in": "query", "description": "Message ID", "schema": { "type": "string" } }, { "name": "author_id", "in": "query", "description": "Author ID", "schema": { "type": "string" } }, { "name": "content", "in": "query", "description": "Content of comment", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `created_at`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/comment" } } } } } }, "summary": "List Comments", "description": "Retrieve a list of comments" }, "post": { "tags": ["Comment"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Comment ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Comment creation date", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "conversation_id": { "type": "string", "description": "Conversation ID", "format": "uuid" }, "message_id": { "type": "string", "description": "Message ID", "format": "uuid", "nullable": true }, "author_id": { "type": "string", "description": "Author ID", "format": "uuid", "nullable": true }, "content": { "type": "object", "description": "Content of comment", "format": "jsonb", "nullable": true }, "text": { "format": "text", "type": "string", "description": "Text content for the comment. Can be plain text or HTML." } } } } }, "description": "comment", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } } }, "description": "The updated Comment object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Comment", "$ref": "#/components/schemas/comment" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Comment was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "comment", "summary": "Create Comment", "description": "Create a new comment" } }, "/provider": { "get": { "tags": ["Provider"], "parameters": [ { "name": "id", "in": "query", "description": "Provider ID", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Provider creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of provider", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status of provider", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Typ of provider", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/provider" } } } } } }, "summary": "List Providers", "description": "Retrieve a list of providers" } }, "/provider_template_approval": { "get": { "tags": ["Provider Template Approval"], "parameters": [ { "name": "provider_id", "in": "query", "description": "Provider ID", "schema": { "type": "string" } }, { "name": "template_id", "in": "query", "description": "Template ID", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Provider template approval creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "status", "in": "query", "description": "Status of provider template approval", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "rejection_reason", "in": "query", "description": "Rejection reason of provider template approval", "schema": { "type": "string" } }, { "name": "category", "in": "query", "description": "Category of provider template approval", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/provider_template_approval" } } } } } }, "summary": "List Provider Template Approvals", "description": "Retrieve a list of provider template approvals" } }, "/import": { "get": { "tags": ["Import"], "parameters": [ { "name": "id", "in": "query", "description": "Import ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Import creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Type of import", "schema": { "type": "string" } }, { "name": "payload", "in": "query", "description": "Payload of import for small imports", "schema": { "type": "string" } }, { "name": "contact_list_id", "in": "query", "description": "ID of the contact list that the contacts should be assigned to", "schema": { "type": "string" } }, { "name": "contact_list_external_id", "in": "query", "description": "External ID of the contact list that the contacts should be assigned to", "schema": { "type": "string" } }, { "name": "failed_url", "in": "query", "description": "URL to download the failed contacts", "schema": { "type": "string" } }, { "name": "payload_url", "in": "query", "description": "URL to download the payload for large imports", "schema": { "type": "string" } }, { "name": "total_count", "in": "query", "description": "Total number of contacts in the import", "schema": { "type": "string" } }, { "name": "success_count", "in": "query", "description": "Number of contacts successfully imported", "schema": { "type": "string" } }, { "name": "failed_count", "in": "query", "description": "Number of contacts that failed to import", "schema": { "type": "string" } }, { "name": "reference_id", "in": "query", "description": "An optional reference ID provided during the import", "schema": { "type": "string" } }, { "name": "hints", "in": "query", "description": "Optional hints for the import, e.g. to indicate if a field was stolen from another contact. We only store the first 20 hints.", "schema": { "type": "string" } }, { "name": "allow_deal_reassignment", "in": "query", "description": "If true, a deal currently assigned to another contact will be re-assigned", "schema": { "type": "string" } }, { "name": "allow_appointment_reassignment", "in": "query", "description": "If true, an appointment currently assigned to another contact will be re-assigned", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `created_at`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/import" } } } } } }, "summary": "List Imports", "description": "Retrieve a list of imports" }, "post": { "tags": ["Import"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "type": { "type": "string", "description": "Type of import", "format": "public.import_type", "enum": [ "contact_details", "deal_details", "appointment_details" ] }, "payload": { "type": "object", "description": "Payload of import for small imports", "format": "jsonb", "nullable": true }, "contact_list_id": { "type": "string", "description": "ID of the contact list that the contacts should be assigned to", "format": "uuid", "nullable": true }, "contact_list_external_id": { "type": "string", "description": "External ID of the contact list that the contacts should be assigned to", "format": "text", "nullable": true }, "allow_deal_reassignment": { "type": "boolean", "description": "If true, a deal currently assigned to another contact will be re-assigned", "format": "boolean", "nullable": true }, "allow_appointment_reassignment": { "type": "boolean", "description": "If true, an appointment currently assigned to another contact will be re-assigned", "format": "boolean", "nullable": true } } } } }, "description": "import", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/import" } } }, "description": "The updated Import object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Import", "$ref": "#/components/schemas/import" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Import was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "import", "summary": "Create Import", "description": "Create a new import" } }, "/campaign": { "get": { "tags": ["Campaign"], "parameters": [ { "name": "id", "in": "query", "description": "Campaign ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Campaign creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of campaign", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/campaign" } } } } } }, "summary": "List Campaigns", "description": "Retrieve a list of campaigns" } }, "/marketing_channel": { "get": { "tags": ["Marketing Channel"], "parameters": [ { "name": "id", "in": "query", "description": "Marketing channel ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Marketing channel creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of marketing channel", "schema": { "type": "string" } }, { "name": "key", "in": "query", "description": "Marketing channel key", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/marketing_channel" } } } } } }, "summary": "List Marketing Channels", "description": "Retrieve a list of marketing channels" } }, "/journey_node": { "get": { "tags": ["Journey Node"], "parameters": [ { "name": "id", "in": "query", "description": "Journey node ID", "schema": { "type": "string" } }, { "name": "journey_version_id", "in": "query", "description": "Journey version ID", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "type", "in": "query", "description": "Node type", "schema": { "type": "string" } }, { "name": "event_type", "in": "query", "description": "Event type for trigger nodes", "schema": { "type": "string" } }, { "name": "extra_context_schema", "in": "query", "description": "Schema for additional context data", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Node name", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/journey_node" } } } } } }, "summary": "List Journey Nodes", "description": "Retrieve a list of journey nodes" } }, "/employee": { "get": { "tags": ["Employee"], "parameters": [ { "name": "id", "in": "query", "description": "Employee ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Employee creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "description": "User ID", "schema": { "type": "string" } }, { "name": "is_admin", "in": "query", "description": "Is employee an admin?", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "Name of employee", "schema": { "type": "string" } }, { "name": "signature", "in": "query", "description": "Signature of employee", "schema": { "type": "string" } }, { "name": "full_name", "in": "query", "description": "Name of employee", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email of employee", "schema": { "type": "string" } }, { "name": "display_name", "in": "query", "description": "Displayed name of the employee in the Mateo app", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/employee" } } } } } }, "summary": "List Employees", "description": "Retrieve a list of employees" }, "post": { "tags": ["Employee"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/employee" } } }, "description": "employee", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/employee" } } }, "description": "The updated Employee object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Employee", "$ref": "#/components/schemas/employee" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Employee was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "employee", "summary": "Create Employee", "description": "Create a new employee" }, "delete": { "tags": ["Employee"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Employee ID", "schema": { "type": "string" }, "required": true }, { "name": "created_at", "in": "query", "description": "Employee creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "description": "User ID", "schema": { "type": "string" } }, { "name": "is_admin", "in": "query", "description": "Is employee an admin?", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "Name of employee", "schema": { "type": "string" } }, { "name": "signature", "in": "query", "description": "Signature of employee", "schema": { "type": "string" } }, { "name": "full_name", "in": "query", "description": "Name of employee", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email of employee", "schema": { "type": "string" } }, { "name": "display_name", "in": "query", "description": "Displayed name of the employee in the Mateo app", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/employee" } } }, "description": "The updated Employee object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Employee", "description": "Delete an existing employee" }, "patch": { "tags": ["Employee"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Employee ID", "schema": { "type": "string" }, "required": true }, { "name": "created_at", "in": "query", "description": "Employee creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "user_id", "in": "query", "description": "User ID", "schema": { "type": "string" } }, { "name": "is_admin", "in": "query", "description": "Is employee an admin?", "schema": { "type": "string" } }, { "name": "username", "in": "query", "description": "Name of employee", "schema": { "type": "string" } }, { "name": "signature", "in": "query", "description": "Signature of employee", "schema": { "type": "string" } }, { "name": "full_name", "in": "query", "description": "Name of employee", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email of employee", "schema": { "type": "string" } }, { "name": "display_name", "in": "query", "description": "Displayed name of the employee in the Mateo app", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/employee" } } }, "description": "employee", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/employee" } } }, "description": "The updated Employee object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "employee", "summary": "Update Employee", "description": "Update an existing employee" } }, "/contact/merge": { "post": { "tags": ["Contact"], "parameters": [], "requestBody": { "content": { "application/json": { "schema": { "required": ["v_from_id", "v_into_id"], "type": "object", "properties": { "v_from_id": { "type": "string", "format": "uuid" }, "v_into_id": { "type": "string", "format": "uuid" } } } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "required": ["v_from_id", "v_into_id"], "type": "object", "properties": { "v_from_id": { "type": "string", "format": "uuid" }, "v_into_id": { "type": "string", "format": "uuid" } } } }, "application/vnd.pgrst.object+json": { "schema": { "required": ["v_from_id", "v_into_id"], "type": "object", "properties": { "v_from_id": { "type": "string", "format": "uuid" }, "v_into_id": { "type": "string", "format": "uuid" } } } }, "text/csv": { "schema": { "required": ["v_from_id", "v_into_id"], "type": "object", "properties": { "v_from_id": { "type": "string", "format": "uuid" }, "v_into_id": { "type": "string", "format": "uuid" } } } } }, "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact" } } }, "description": "Contact merged successfully" } }, "x-codegen-request-body-name": "args", "summary": "Merge Contacts", "description": "Merge two contacts into a new one" } }, "/storage/sign/{bucketName}/*": { "post": { "operationId": "postSignByBucketName", "tags": ["Storage"], "summary": "Create Signed Url", "description": "Create a signed url for an object in a bucket. You can use this url to download the object", "parameters": [ { "name": "bucketName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "objectName", "in": "path", "required": true, "description": "The name of the object in the bucket including slashes", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/text": { "schema": { "type": "string", "description": "A signed url for the object in the bucket. It is valid for five minutes." } } }, "description": "The signed url has been created successfully" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "statusCode": { "type": "number" } }, "required": ["code", "message", "statusCode"] } } }, "description": "Invalid input provided" } } } }, "/storage/upload/sign/{bucketName}/*": { "post": { "operationId": "postUploadSignByBucketName", "tags": ["Storage"], "summary": "Create Signed Upload Url", "description": "Create a signed upload url for an object in a bucket. You can use this url to upload the object", "parameters": [ { "name": "bucketName", "in": "path", "required": true, "schema": { "type": "string" } }, { "name": "objectName", "in": "path", "required": true, "description": "The name of the object in the bucket including slashes", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/text": { "schema": { "type": "string", "description": "A signed url to upload the object to the bucket. It is valid for 120 minutes." } } }, "description": "The signed upload url has been created successfully" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "statusCode": { "type": "number" } }, "required": ["code", "message", "statusCode"] } } }, "description": "Invalid input provided" } } } }, "/contact_details": { "get": { "tags": ["Contact Details"], "parameters": [ { "name": "id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Contact creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "full_name", "in": "query", "description": "Name of contact", "schema": { "type": "string" } }, { "name": "fts", "in": "query", "description": "Handle of contact", "schema": { "type": "string" } }, { "name": "is_blocked", "in": "query", "description": "Is the contact blocked?", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "secondary_external_id", "in": "query", "description": "Secondary External ID", "schema": { "type": "string" } }, { "name": "birthday", "in": "query", "description": "Birthday of the contact", "schema": { "type": "string" } }, { "name": "salutation", "in": "query", "description": "Salutation", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email of contact", "schema": { "type": "string" } }, { "name": "sms", "in": "query", "description": "SMS of contact", "schema": { "type": "string" } }, { "name": "whatsapp", "in": "query", "description": "Whatsapp Number", "schema": { "type": "string" } }, { "name": "instagram", "in": "query", "description": "Instagram", "schema": { "type": "string" } }, { "name": "facebook", "in": "query", "description": "Facebook", "schema": { "type": "string" } }, { "name": "display_name", "in": "query", "description": "Displayed name of contact in the Mateo app", "schema": { "type": "string" } }, { "name": "google_business_messaging", "in": "query", "description": "Google business messaging account of contact", "schema": { "type": "string" } }, { "name": "address_line1", "in": "query", "description": "First line of the postal address", "schema": { "type": "string" } }, { "name": "address_line2", "in": "query", "description": "Second line of the postal address", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "City of the postal address", "schema": { "type": "string" } }, { "name": "zipcode", "in": "query", "description": "Postal code or ZIP code of the address", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Country of the postal address", "schema": { "type": "string" } }, { "name": "postal", "in": "query", "description": "Postal handle or identifier for the contact", "schema": { "type": "string" } }, { "name": "number_of_marketing_opt_in_requests", "in": "query", "description": "Number of marketing opt in requests", "schema": { "type": "string" } }, { "name": "latest_marketing_opt_in_request_sent_at", "in": "query", "description": "Latest marketing opt in request sent at", "schema": { "type": "string" } }, { "name": "campaign_messages_this_month", "in": "query", "description": "Campaign Messages this month", "schema": { "type": "string" } }, { "name": "whatsapp_marketing_opt_in", "in": "query", "description": "WhatsApp marketign opt in", "schema": { "type": "string" } }, { "name": "sms_marketing_opt_in", "in": "query", "description": "SMS marketing opt in", "schema": { "type": "string" } }, { "name": "email_marketing_opt_in", "in": "query", "description": "Email marketing opt in of contact", "schema": { "type": "string" } }, { "name": "facebook_marketing_opt_in", "in": "query", "description": "Facebook marketing opt in", "schema": { "type": "string" } }, { "name": "instagram_marketing_opt_in", "in": "query", "description": "Instagram marketing opt in", "schema": { "type": "string" } }, { "name": "google_business_messaging_marketing_opt_in", "in": "query", "description": "Google business messaging marketing opt in", "schema": { "type": "string" } }, { "name": "postal_marketing_opt_in", "in": "query", "description": "Postal marketing opt in status", "schema": { "type": "string" } }, { "name": "whatsapp_transactional_opt_in", "in": "query", "description": "WhatsApp transactional opt in", "schema": { "type": "string" } }, { "name": "sms_transactional_opt_in", "in": "query", "description": "SMS transactional opt in", "schema": { "type": "string" } }, { "name": "email_transactional_opt_in", "in": "query", "description": "Email transactional opt in", "schema": { "type": "string" } }, { "name": "facebook_transactional_opt_in", "in": "query", "description": "Facebook transactional opt in", "schema": { "type": "string" } }, { "name": "instagram_transactional_opt_in", "in": "query", "description": "Instagram transactional opt in", "schema": { "type": "string" } }, { "name": "google_business_messaging_transactional_opt_in", "in": "query", "description": "Google business messaging transactional opt in", "schema": { "type": "string" } }, { "name": "postal_transactional_opt_in", "in": "query", "description": "Postal transactional opt in status", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `created_at`, `display_name`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/contact_details" } } } } } }, "summary": "List Contact Details", "description": "Retrieve a list of contact data with marketing channels and custom fields" }, "post": { "tags": ["Contact Details"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Contact ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Contact creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "full_name": { "type": "string", "description": "Name of contact", "format": "text", "nullable": true }, "fts": { "type": "string", "description": "Handle of contact", "format": "tsvector", "nullable": true }, "is_blocked": { "type": "boolean", "description": "Is the contact blocked?", "format": "boolean", "default": false }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "secondary_external_id": { "type": "string", "description": "Secondary External ID", "format": "text", "nullable": true }, "birthday": { "type": "string", "description": "Birthday of the contact", "format": "date", "nullable": true }, "salutation": { "type": "string", "description": "Salutation", "format": "text", "nullable": true }, "email": { "type": "string", "description": "Email of contact", "format": "text", "nullable": true }, "sms": { "type": "string", "description": "SMS of contact", "format": "text", "nullable": true }, "whatsapp": { "type": "string", "description": "Whatsapp Number", "format": "text", "nullable": true }, "instagram": { "type": "string", "description": "Instagram", "format": "text", "nullable": true }, "facebook": { "type": "string", "description": "Facebook", "format": "text", "nullable": true }, "google_business_messaging": { "type": "string", "description": "Google business messaging account of contact", "format": "text", "nullable": true }, "address_line1": { "type": "string", "description": "First line of the postal address", "format": "text", "nullable": true }, "address_line2": { "type": "string", "description": "Second line of the postal address", "format": "text", "nullable": true }, "city": { "type": "string", "description": "City of the postal address", "format": "text", "nullable": true }, "zipcode": { "type": "string", "description": "Postal code or ZIP code of the address", "format": "text", "nullable": true }, "country": { "type": "string", "description": "Country of the postal address", "format": "text", "nullable": true }, "postal": { "type": "string", "description": "Postal handle or identifier for the contact", "format": "text", "nullable": true }, "number_of_marketing_opt_in_requests": { "type": "integer", "description": "Number of marketing opt in requests", "format": "integer" }, "latest_marketing_opt_in_request_sent_at": { "type": "string", "description": "Latest marketing opt in request sent at", "format": "timestamp with time zone", "nullable": true }, "campaign_messages_this_month": { "type": "integer", "description": "Campaign Messages this month", "format": "integer" }, "whatsapp_marketing_opt_in": { "type": "boolean", "description": "WhatsApp marketign opt in", "format": "boolean", "default": false }, "sms_marketing_opt_in": { "type": "boolean", "description": "SMS marketing opt in", "format": "boolean", "default": false }, "email_marketing_opt_in": { "type": "boolean", "description": "Email marketing opt in of contact", "format": "boolean", "default": false }, "facebook_marketing_opt_in": { "type": "boolean", "description": "Facebook marketing opt in", "format": "boolean", "default": false }, "instagram_marketing_opt_in": { "type": "boolean", "description": "Instagram marketing opt in", "format": "boolean", "default": false }, "google_business_messaging_marketing_opt_in": { "type": "boolean", "description": "Google business messaging marketing opt in", "format": "boolean", "default": false }, "postal_marketing_opt_in": { "type": "boolean", "description": "Postal marketing opt in status", "format": "boolean", "default": true }, "whatsapp_transactional_opt_in": { "type": "string", "description": "WhatsApp transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "sms_transactional_opt_in": { "type": "string", "description": "SMS transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "email_transactional_opt_in": { "type": "string", "description": "Email transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "facebook_transactional_opt_in": { "type": "string", "description": "Facebook transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "instagram_transactional_opt_in": { "type": "string", "description": "Instagram transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "google_business_messaging_transactional_opt_in": { "type": "string", "description": "Google business messaging transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "postal_transactional_opt_in": { "type": "string", "description": "Postal transactional opt in status", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true } } } } }, "description": "contact", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_details" } } }, "description": "The updated Contact object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Contact", "$ref": "#/components/schemas/contact_details" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Contact was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "contact", "summary": "Create Contact Details", "description": "Create a new contact data with marketing channels and custom fields" }, "delete": { "tags": ["Contact Details"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Contact creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "full_name", "in": "query", "description": "Name of contact", "schema": { "type": "string" } }, { "name": "fts", "in": "query", "description": "Handle of contact", "schema": { "type": "string" } }, { "name": "is_blocked", "in": "query", "description": "Is the contact blocked?", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "secondary_external_id", "in": "query", "description": "Secondary External ID", "schema": { "type": "string" } }, { "name": "birthday", "in": "query", "description": "Birthday of the contact", "schema": { "type": "string" } }, { "name": "salutation", "in": "query", "description": "Salutation", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email of contact", "schema": { "type": "string" } }, { "name": "sms", "in": "query", "description": "SMS of contact", "schema": { "type": "string" } }, { "name": "whatsapp", "in": "query", "description": "Whatsapp Number", "schema": { "type": "string" } }, { "name": "instagram", "in": "query", "description": "Instagram", "schema": { "type": "string" } }, { "name": "facebook", "in": "query", "description": "Facebook", "schema": { "type": "string" } }, { "name": "display_name", "in": "query", "description": "Displayed name of contact in the Mateo app", "schema": { "type": "string" } }, { "name": "google_business_messaging", "in": "query", "description": "Google business messaging account of contact", "schema": { "type": "string" } }, { "name": "address_line1", "in": "query", "description": "First line of the postal address", "schema": { "type": "string" } }, { "name": "address_line2", "in": "query", "description": "Second line of the postal address", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "City of the postal address", "schema": { "type": "string" } }, { "name": "zipcode", "in": "query", "description": "Postal code or ZIP code of the address", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Country of the postal address", "schema": { "type": "string" } }, { "name": "postal", "in": "query", "description": "Postal handle or identifier for the contact", "schema": { "type": "string" } }, { "name": "number_of_marketing_opt_in_requests", "in": "query", "description": "Number of marketing opt in requests", "schema": { "type": "string" } }, { "name": "latest_marketing_opt_in_request_sent_at", "in": "query", "description": "Latest marketing opt in request sent at", "schema": { "type": "string" } }, { "name": "campaign_messages_this_month", "in": "query", "description": "Campaign Messages this month", "schema": { "type": "string" } }, { "name": "whatsapp_marketing_opt_in", "in": "query", "description": "WhatsApp marketign opt in", "schema": { "type": "string" } }, { "name": "sms_marketing_opt_in", "in": "query", "description": "SMS marketing opt in", "schema": { "type": "string" } }, { "name": "email_marketing_opt_in", "in": "query", "description": "Email marketing opt in of contact", "schema": { "type": "string" } }, { "name": "facebook_marketing_opt_in", "in": "query", "description": "Facebook marketing opt in", "schema": { "type": "string" } }, { "name": "instagram_marketing_opt_in", "in": "query", "description": "Instagram marketing opt in", "schema": { "type": "string" } }, { "name": "google_business_messaging_marketing_opt_in", "in": "query", "description": "Google business messaging marketing opt in", "schema": { "type": "string" } }, { "name": "postal_marketing_opt_in", "in": "query", "description": "Postal marketing opt in status", "schema": { "type": "string" } }, { "name": "whatsapp_transactional_opt_in", "in": "query", "description": "WhatsApp transactional opt in", "schema": { "type": "string" } }, { "name": "sms_transactional_opt_in", "in": "query", "description": "SMS transactional opt in", "schema": { "type": "string" } }, { "name": "email_transactional_opt_in", "in": "query", "description": "Email transactional opt in", "schema": { "type": "string" } }, { "name": "facebook_transactional_opt_in", "in": "query", "description": "Facebook transactional opt in", "schema": { "type": "string" } }, { "name": "instagram_transactional_opt_in", "in": "query", "description": "Instagram transactional opt in", "schema": { "type": "string" } }, { "name": "google_business_messaging_transactional_opt_in", "in": "query", "description": "Google business messaging transactional opt in", "schema": { "type": "string" } }, { "name": "postal_transactional_opt_in", "in": "query", "description": "Postal transactional opt in status", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_details" } } }, "description": "The updated Contact object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Contact", "description": "Delete an existing contact" }, "patch": { "tags": ["Contact Details"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Contact creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "full_name", "in": "query", "description": "Name of contact", "schema": { "type": "string" } }, { "name": "fts", "in": "query", "description": "Handle of contact", "schema": { "type": "string" } }, { "name": "is_blocked", "in": "query", "description": "Is the contact blocked?", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "secondary_external_id", "in": "query", "description": "Secondary External ID", "schema": { "type": "string" } }, { "name": "birthday", "in": "query", "description": "Birthday of the contact", "schema": { "type": "string" } }, { "name": "salutation", "in": "query", "description": "Salutation", "schema": { "type": "string" } }, { "name": "email", "in": "query", "description": "Email of contact", "schema": { "type": "string" } }, { "name": "sms", "in": "query", "description": "SMS of contact", "schema": { "type": "string" } }, { "name": "whatsapp", "in": "query", "description": "Whatsapp Number", "schema": { "type": "string" } }, { "name": "instagram", "in": "query", "description": "Instagram", "schema": { "type": "string" } }, { "name": "facebook", "in": "query", "description": "Facebook", "schema": { "type": "string" } }, { "name": "display_name", "in": "query", "description": "Displayed name of contact in the Mateo app", "schema": { "type": "string" } }, { "name": "google_business_messaging", "in": "query", "description": "Google business messaging account of contact", "schema": { "type": "string" } }, { "name": "address_line1", "in": "query", "description": "First line of the postal address", "schema": { "type": "string" } }, { "name": "address_line2", "in": "query", "description": "Second line of the postal address", "schema": { "type": "string" } }, { "name": "city", "in": "query", "description": "City of the postal address", "schema": { "type": "string" } }, { "name": "zipcode", "in": "query", "description": "Postal code or ZIP code of the address", "schema": { "type": "string" } }, { "name": "country", "in": "query", "description": "Country of the postal address", "schema": { "type": "string" } }, { "name": "postal", "in": "query", "description": "Postal handle or identifier for the contact", "schema": { "type": "string" } }, { "name": "number_of_marketing_opt_in_requests", "in": "query", "description": "Number of marketing opt in requests", "schema": { "type": "string" } }, { "name": "latest_marketing_opt_in_request_sent_at", "in": "query", "description": "Latest marketing opt in request sent at", "schema": { "type": "string" } }, { "name": "campaign_messages_this_month", "in": "query", "description": "Campaign Messages this month", "schema": { "type": "string" } }, { "name": "whatsapp_marketing_opt_in", "in": "query", "description": "WhatsApp marketign opt in", "schema": { "type": "string" } }, { "name": "sms_marketing_opt_in", "in": "query", "description": "SMS marketing opt in", "schema": { "type": "string" } }, { "name": "email_marketing_opt_in", "in": "query", "description": "Email marketing opt in of contact", "schema": { "type": "string" } }, { "name": "facebook_marketing_opt_in", "in": "query", "description": "Facebook marketing opt in", "schema": { "type": "string" } }, { "name": "instagram_marketing_opt_in", "in": "query", "description": "Instagram marketing opt in", "schema": { "type": "string" } }, { "name": "google_business_messaging_marketing_opt_in", "in": "query", "description": "Google business messaging marketing opt in", "schema": { "type": "string" } }, { "name": "postal_marketing_opt_in", "in": "query", "description": "Postal marketing opt in status", "schema": { "type": "string" } }, { "name": "whatsapp_transactional_opt_in", "in": "query", "description": "WhatsApp transactional opt in", "schema": { "type": "string" } }, { "name": "sms_transactional_opt_in", "in": "query", "description": "SMS transactional opt in", "schema": { "type": "string" } }, { "name": "email_transactional_opt_in", "in": "query", "description": "Email transactional opt in", "schema": { "type": "string" } }, { "name": "facebook_transactional_opt_in", "in": "query", "description": "Facebook transactional opt in", "schema": { "type": "string" } }, { "name": "instagram_transactional_opt_in", "in": "query", "description": "Instagram transactional opt in", "schema": { "type": "string" } }, { "name": "google_business_messaging_transactional_opt_in", "in": "query", "description": "Google business messaging transactional opt in", "schema": { "type": "string" } }, { "name": "postal_transactional_opt_in", "in": "query", "description": "Postal transactional opt in status", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "type": "object", "properties": { "id": { "type": "string", "description": "Contact ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Contact creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "full_name": { "type": "string", "description": "Name of contact", "format": "text", "nullable": true }, "fts": { "type": "string", "description": "Handle of contact", "format": "tsvector", "nullable": true }, "is_blocked": { "type": "boolean", "description": "Is the contact blocked?", "format": "boolean", "default": false }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "secondary_external_id": { "type": "string", "description": "Secondary External ID", "format": "text", "nullable": true }, "birthday": { "type": "string", "description": "Birthday of the contact", "format": "date", "nullable": true }, "salutation": { "type": "string", "description": "Salutation", "format": "text", "nullable": true }, "email": { "type": "string", "description": "Email of contact", "format": "text", "nullable": true }, "sms": { "type": "string", "description": "SMS of contact", "format": "text", "nullable": true }, "whatsapp": { "type": "string", "description": "Whatsapp Number", "format": "text", "nullable": true }, "instagram": { "type": "string", "description": "Instagram", "format": "text", "nullable": true }, "facebook": { "type": "string", "description": "Facebook", "format": "text", "nullable": true }, "google_business_messaging": { "type": "string", "description": "Google business messaging account of contact", "format": "text", "nullable": true }, "address_line1": { "type": "string", "description": "First line of the postal address", "format": "text", "nullable": true }, "address_line2": { "type": "string", "description": "Second line of the postal address", "format": "text", "nullable": true }, "city": { "type": "string", "description": "City of the postal address", "format": "text", "nullable": true }, "zipcode": { "type": "string", "description": "Postal code or ZIP code of the address", "format": "text", "nullable": true }, "country": { "type": "string", "description": "Country of the postal address", "format": "text", "nullable": true }, "postal": { "type": "string", "description": "Postal handle or identifier for the contact", "format": "text", "nullable": true }, "number_of_marketing_opt_in_requests": { "type": "integer", "description": "Number of marketing opt in requests", "format": "integer" }, "latest_marketing_opt_in_request_sent_at": { "type": "string", "description": "Latest marketing opt in request sent at", "format": "timestamp with time zone", "nullable": true }, "campaign_messages_this_month": { "type": "integer", "description": "Campaign Messages this month", "format": "integer" }, "whatsapp_marketing_opt_in": { "type": "boolean", "description": "WhatsApp marketign opt in", "format": "boolean", "default": false }, "sms_marketing_opt_in": { "type": "boolean", "description": "SMS marketing opt in", "format": "boolean", "default": false }, "email_marketing_opt_in": { "type": "boolean", "description": "Email marketing opt in of contact", "format": "boolean", "default": false }, "facebook_marketing_opt_in": { "type": "boolean", "description": "Facebook marketing opt in", "format": "boolean", "default": false }, "instagram_marketing_opt_in": { "type": "boolean", "description": "Instagram marketing opt in", "format": "boolean", "default": false }, "google_business_messaging_marketing_opt_in": { "type": "boolean", "description": "Google business messaging marketing opt in", "format": "boolean", "default": false }, "postal_marketing_opt_in": { "type": "boolean", "description": "Postal marketing opt in status", "format": "boolean", "default": true }, "whatsapp_transactional_opt_in": { "type": "string", "description": "WhatsApp transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "sms_transactional_opt_in": { "type": "string", "description": "SMS transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "email_transactional_opt_in": { "type": "string", "description": "Email transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "facebook_transactional_opt_in": { "type": "string", "description": "Facebook transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "instagram_transactional_opt_in": { "type": "string", "description": "Instagram transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "google_business_messaging_transactional_opt_in": { "type": "string", "description": "Google business messaging transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "postal_transactional_opt_in": { "type": "string", "description": "Postal transactional opt in status", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true } } } } }, "description": "contact", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_details" } } }, "description": "The updated Contact object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "contact", "summary": "Update Contact Details", "description": "Update an existing contact data with marketing channels and custom fields" } }, "/deal_details": { "get": { "tags": ["Deal Details"], "parameters": [ { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the deal", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "type_key", "in": "query", "description": "Type Key", "schema": { "type": "string" } }, { "name": "status_key", "in": "query", "description": "Status Key", "schema": { "type": "string" } }, { "name": "assignee_id", "in": "query", "description": "Assignee ID", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value of the deal", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Currency of the deal", "schema": { "type": "string" } }, { "name": "won_at", "in": "query", "description": "Won at timestamp", "schema": { "type": "string" } }, { "name": "lost_at", "in": "query", "description": "Lost at timestamp", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `lost_at`, `won_at`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/deal_details" } } } } } }, "summary": "List Deal Details", "description": "Retrieve a list of deal data with custom fields" }, "post": { "tags": ["Deal Details"], "parameters": [ { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal_details" } } }, "description": "deal", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal_details" } } }, "description": "The updated Deal object" }, "201": { "content": { "application/json": { "schema": { "oneOf": [ { "title": "Deal", "$ref": "#/components/schemas/deal_details" }, { "title": "Empty", "type": "object", "properties": {} } ] } } }, "description": "The Deal was created" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "deal", "summary": "Create Deal Details", "description": "Create a new deal data with custom fields" }, "delete": { "tags": ["Deal Details"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the deal", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "type_key", "in": "query", "description": "Type Key", "schema": { "type": "string" } }, { "name": "status_key", "in": "query", "description": "Status Key", "schema": { "type": "string" } }, { "name": "assignee_id", "in": "query", "description": "Assignee ID", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value of the deal", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Currency of the deal", "schema": { "type": "string" } }, { "name": "won_at", "in": "query", "description": "Won at timestamp", "schema": { "type": "string" } }, { "name": "lost_at", "in": "query", "description": "Lost at timestamp", "schema": { "type": "string" } } ], "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal_details" } } }, "description": "The updated Deal object" }, "204": { "content": {}, "description": "No Content" } }, "summary": "Delete Deal", "description": "Delete an existing deal" }, "patch": { "tags": ["Deal Details"], "parameters": [ { "description": "Select columns to return", "in": "query", "name": "select", "schema": { "type": "string" } }, { "name": "id", "in": "query", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the deal", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "type_key", "in": "query", "description": "Type Key", "schema": { "type": "string" } }, { "name": "status_key", "in": "query", "description": "Status Key", "schema": { "type": "string" } }, { "name": "assignee_id", "in": "query", "description": "Assignee ID", "schema": { "type": "string" } }, { "name": "value", "in": "query", "description": "Value of the deal", "schema": { "type": "string" } }, { "name": "currency", "in": "query", "description": "Currency of the deal", "schema": { "type": "string" } }, { "name": "won_at", "in": "query", "description": "Won at timestamp", "schema": { "type": "string" } }, { "name": "lost_at", "in": "query", "description": "Lost at timestamp", "schema": { "type": "string" } } ], "requestBody": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal_details" } } }, "description": "deal", "required": true }, "responses": { "200": { "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal_details" } } }, "description": "The updated Deal object" }, "204": { "content": {}, "description": "No Content" } }, "x-codegen-request-body-name": "deal", "summary": "Update Deal Details", "description": "Update an existing deal data with custom fields" } }, "/appointment_details": { "get": { "tags": ["Appointment Details"], "parameters": [ { "name": "id", "in": "query", "description": "Appointment ID", "schema": { "type": "string" } }, { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, { "name": "name", "in": "query", "description": "Name of the appointment", "schema": { "type": "string" } }, { "name": "description", "in": "query", "description": "Description of the appointment", "schema": { "type": "string" } }, { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, { "name": "status_key", "in": "query", "description": "Status Key", "schema": { "type": "string" } }, { "name": "type_key", "in": "query", "description": "Type Key", "schema": { "type": "string" } }, { "name": "assignee_id", "in": "query", "description": "Assignee ID", "schema": { "type": "string" } }, { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, { "name": "start_time", "in": "query", "description": "Start time of the appointment", "schema": { "type": "string" } }, { "name": "end_time", "in": "query", "description": "End time of the appointment", "schema": { "type": "string" } }, { "name": "confirmed_at", "in": "query", "description": "Confirmed at timestamp", "schema": { "type": "string" } }, { "name": "cancelled_at", "in": "query", "description": "Cancelled at timestamp", "schema": { "type": "string" } }, { "name": "location_id", "in": "query", "description": "Location ID", "schema": { "type": "string" } }, { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, { "name": "order", "in": "query", "description": "Ordering. Allowed Fields: `start_time`", "schema": { "type": "string" } }, { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } } ], "responses": { "200": { "description": "OK", "content": { "application/json": { "schema": { "type": "array", "items": { "$ref": "#/components/schemas/appointment_details" } } } } } }, "summary": "List Appointment Details", "description": "Retrieve a list of appointment data with custom fields" } }, "/webhook_receivers/sapemarsys/send_message": { "post": { "operationId": "postSapemarsysSendMessage", "tags": ["SAP Emarsys", "Webhooks", "Send Message"], "summary": "Receive Webhook from SAP Emarsys", "description": "Receive a webhook from SAP Emarsys to send a message", "responses": { "204": { "description": "The webhook was received successfully" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "statusCode": { "type": "number" } }, "required": ["code", "message", "statusCode"] } } }, "description": "Invalid input provided" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "deduplication_id": { "type": "string", "description": "Id to dedupe the event" }, "country_code": { "description": "Country code for formatting the phone numbers", "type": "string", "enum": [ "DE", "US", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW" ] }, "handle": { "type": "string", "description": "The handle to send the message to" }, "full_name": { "type": "string", "description": "The name of the recipient" }, "channel_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The channel to send the message from" }, "template_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The template to send" } }, "required": [ "deduplication_id", "handle", "full_name", "channel_id", "template_id" ], "additionalProperties": {} } } } }, "parameters": [] } }, "/journey_execution": { "post": { "operationId": "postIndex4", "tags": ["Journey Execution"], "summary": "Start a journey execution", "description": "Trigger a journey execution for a contact via HTTP webhook", "responses": { "202": { "description": "Journey execution started successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "journey_execution_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "contact_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["success", "journey_execution_id", "contact_id"] } } } }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "statusCode": { "type": "number" } }, "required": ["code", "message", "statusCode"] } } }, "description": "Invalid input or context validation failed" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "statusCode": { "type": "number" } }, "required": ["code", "message", "statusCode"] } } }, "description": "Journey version or trigger node not found" }, "409": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" }, "contact_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "journey_version_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, "required": ["message", "contact_id", "journey_version_id"] } } }, "description": "Journey execution already active for this contact" }, "500": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "statusCode": { "type": "number" } }, "required": ["code", "message", "statusCode"] } } }, "description": "Internal server error" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "journey_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The journey ID to execute" }, "context": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "Context data for the journey execution, must match the schema defined in the journey trigger node" }, "contact": { "type": "object", "properties": { "address_line1": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "address_line2": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "birthday": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "campaign_messages_this_month": { "type": "number" }, "city": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "country": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "created_at": { "type": "string" }, "created_by": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "created_by_api_token_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "created_by_employee_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "created_by_import_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "deleted_at": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "description": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "display_name": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "email": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "email_health": { "anyOf": [ { "type": "string", "enum": ["healthy", "unhealthy", "unknown"] }, { "type": "null" } ] }, "email_marketing_messages_this_month": { "type": "number" }, "email_marketing_opt_in": { "type": "boolean" }, "email_transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "external_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "facebook": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "facebook_health": { "anyOf": [ { "type": "string", "enum": ["healthy", "unhealthy", "unknown"] }, { "type": "null" } ] }, "facebook_marketing_messages_this_month": { "type": "number" }, "facebook_marketing_opt_in": { "type": "boolean" }, "facebook_transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "fts": {}, "full_name": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "google_business_messaging": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "google_business_messaging_health": { "anyOf": [ { "type": "string", "enum": ["healthy", "unhealthy", "unknown"] }, { "type": "null" } ] }, "google_business_messaging_marketing_messages_this_month": { "type": "number" }, "google_business_messaging_marketing_opt_in": { "type": "boolean" }, "google_business_messaging_transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "id": { "type": "string" }, "influenced_revenue": { "type": "number" }, "instagram": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "instagram_health": { "anyOf": [ { "type": "string", "enum": ["healthy", "unhealthy", "unknown"] }, { "type": "null" } ] }, "instagram_marketing_messages_this_month": { "type": "number" }, "instagram_marketing_opt_in": { "type": "boolean" }, "instagram_transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "is_blocked": { "type": "boolean" }, "last_external_review_rating": { "anyOf": [{ "type": "number" }, { "type": "null" }] }, "last_interaction_at": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "last_internal_review_rating": { "anyOf": [{ "type": "number" }, { "type": "null" }] }, "last_outbound_at": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "last_review_rating": { "anyOf": [{ "type": "number" }, { "type": "null" }] }, "latest_marketing_opt_in_request_sent_at": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "latest_review_request_message_sent_at": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "marketing_opt_in": { "anyOf": [{ "type": "boolean" }, { "type": "null" }] }, "number_of_marketing_opt_in_requests": { "type": "number" }, "organisation_id": { "type": "string" }, "postal": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "postal_health": { "anyOf": [ { "type": "string", "enum": ["healthy", "unhealthy", "unknown"] }, { "type": "null" } ] }, "postal_marketing_messages_this_month": { "anyOf": [{ "type": "number" }, { "type": "null" }] }, "postal_marketing_opt_in": { "type": "boolean" }, "postal_messages_this_month": { "anyOf": [{ "type": "number" }, { "type": "null" }] }, "postal_transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "review_request_message_count": { "type": "number" }, "salutation": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "secondary_external_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "sms": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "sms_health": { "anyOf": [ { "type": "string", "enum": ["healthy", "unhealthy", "unknown"] }, { "type": "null" } ] }, "sms_marketing_messages_this_month": { "type": "number" }, "sms_marketing_opt_in": { "type": "boolean" }, "sms_transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "updated_at": { "type": "string" }, "updated_by": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "updated_by_api_token_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "updated_by_employee_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "updated_by_import_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "whatsapp": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "whatsapp_health": { "anyOf": [ { "type": "string", "enum": ["healthy", "unhealthy", "unknown"] }, { "type": "null" } ] }, "whatsapp_marketing_messages_this_month": { "type": "number" }, "whatsapp_marketing_opt_in": { "type": "boolean" }, "whatsapp_transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "zipcode": { "anyOf": [{ "type": "string" }, { "type": "null" }] } }, "description": "Contact details to import or find" } }, "required": ["journey_id", "contact"] } } } }, "parameters": [] } }, "/journey_execution/batch": { "post": { "operationId": "postBatch", "tags": ["Journey Execution"], "summary": "Start batch journey executions", "description": "Queue multiple journey executions for a single journey. Each contact is processed independently.", "responses": { "202": { "description": "Batch queued successfully", "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" }, "queued_count": { "type": "number" } }, "required": ["success", "queued_count"] } } } }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "statusCode": { "type": "number" } }, "required": ["code", "message", "statusCode"] } } }, "description": "Invalid input or context validation failed" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "statusCode": { "type": "number" } }, "required": ["code", "message", "statusCode"] } } }, "description": "Journey version or trigger node not found" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "journey_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The journey ID to execute" }, "items": { "maxItems": 500, "type": "array", "items": { "type": "object", "properties": { "deduplication_id": { "type": "string", "description": "Unique ID to prevent duplicate processing" }, "contact": { "type": "object", "properties": { "address_line1": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "address_line2": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "birthday": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "campaign_messages_this_month": { "type": "number" }, "city": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "country": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_at": { "type": "string" }, "created_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_by_api_token_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_by_employee_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "created_by_import_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "deleted_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "description": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "display_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "email_health": { "anyOf": [ { "type": "string", "enum": ["healthy", "unhealthy", "unknown"] }, { "type": "null" } ] }, "email_marketing_messages_this_month": { "type": "number" }, "email_marketing_opt_in": { "type": "boolean" }, "email_transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "facebook": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "facebook_health": { "anyOf": [ { "type": "string", "enum": ["healthy", "unhealthy", "unknown"] }, { "type": "null" } ] }, "facebook_marketing_messages_this_month": { "type": "number" }, "facebook_marketing_opt_in": { "type": "boolean" }, "facebook_transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "fts": {}, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "google_business_messaging": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "google_business_messaging_health": { "anyOf": [ { "type": "string", "enum": ["healthy", "unhealthy", "unknown"] }, { "type": "null" } ] }, "google_business_messaging_marketing_messages_this_month": { "type": "number" }, "google_business_messaging_marketing_opt_in": { "type": "boolean" }, "google_business_messaging_transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "id": { "type": "string" }, "influenced_revenue": { "type": "number" }, "instagram": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "instagram_health": { "anyOf": [ { "type": "string", "enum": ["healthy", "unhealthy", "unknown"] }, { "type": "null" } ] }, "instagram_marketing_messages_this_month": { "type": "number" }, "instagram_marketing_opt_in": { "type": "boolean" }, "instagram_transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "is_blocked": { "type": "boolean" }, "last_external_review_rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "last_interaction_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_internal_review_rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "last_outbound_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "last_review_rating": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "latest_marketing_opt_in_request_sent_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "latest_review_request_message_sent_at": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "marketing_opt_in": { "anyOf": [ { "type": "boolean" }, { "type": "null" } ] }, "number_of_marketing_opt_in_requests": { "type": "number" }, "organisation_id": { "type": "string" }, "postal": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "postal_health": { "anyOf": [ { "type": "string", "enum": ["healthy", "unhealthy", "unknown"] }, { "type": "null" } ] }, "postal_marketing_messages_this_month": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "postal_marketing_opt_in": { "type": "boolean" }, "postal_messages_this_month": { "anyOf": [ { "type": "number" }, { "type": "null" } ] }, "postal_transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "review_request_message_count": { "type": "number" }, "salutation": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "secondary_external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sms": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "sms_health": { "anyOf": [ { "type": "string", "enum": ["healthy", "unhealthy", "unknown"] }, { "type": "null" } ] }, "sms_marketing_messages_this_month": { "type": "number" }, "sms_marketing_opt_in": { "type": "boolean" }, "sms_transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "updated_at": { "type": "string" }, "updated_by": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "updated_by_api_token_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "updated_by_employee_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "updated_by_import_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "whatsapp": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "whatsapp_health": { "anyOf": [ { "type": "string", "enum": ["healthy", "unhealthy", "unknown"] }, { "type": "null" } ] }, "whatsapp_marketing_messages_this_month": { "type": "number" }, "whatsapp_marketing_opt_in": { "type": "boolean" }, "whatsapp_transactional_opt_in": { "anyOf": [ { "type": "string", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ] }, { "type": "null" } ] }, "zipcode": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "description": "Contact details to import or find" }, "context": { "anyOf": [ { "type": "object", "propertyNames": { "type": "string" }, "additionalProperties": { "type": "string" } }, { "type": "null" } ], "description": "Context data for this contact, must match the schema defined in the journey trigger node" } }, "required": ["deduplication_id", "contact"] }, "description": "Array of contacts to enroll in the journey (max 500)" } }, "required": ["journey_id", "items"] } } } }, "parameters": [] } }, "/format": { "post": { "operationId": "postIndex", "tags": ["Format"], "summary": "Format Phone Numbers", "description": "Format phone numbers to E.164 format with specified country codes", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneNumber": { "type": "string", "description": "Formatted phone number(s)" } }, "required": ["phoneNumber"] } } }, "description": "Successfully formatted phone numbers" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "statusCode": { "type": "number" } }, "required": ["code", "message", "statusCode"] } } }, "description": "Invalid input provided" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "phoneNumber": { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ], "description": "Phone number(s) to be formatted" }, "countryCode": { "description": "Country code(s) to try for formatting", "anyOf": [ { "type": "string", "enum": [ "DE", "US", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW" ] }, { "type": "array", "items": { "type": "string", "enum": [ "DE", "US", "AC", "AD", "AE", "AF", "AG", "AI", "AL", "AM", "AO", "AR", "AS", "AT", "AU", "AW", "AX", "AZ", "BA", "BB", "BD", "BE", "BF", "BG", "BH", "BI", "BJ", "BL", "BM", "BN", "BO", "BQ", "BR", "BS", "BT", "BW", "BY", "BZ", "CA", "CC", "CD", "CF", "CG", "CH", "CI", "CK", "CL", "CM", "CN", "CO", "CR", "CU", "CV", "CW", "CX", "CY", "CZ", "DJ", "DK", "DM", "DO", "DZ", "EC", "EE", "EG", "EH", "ER", "ES", "ET", "FI", "FJ", "FK", "FM", "FO", "FR", "GA", "GB", "GD", "GE", "GF", "GG", "GH", "GI", "GL", "GM", "GN", "GP", "GQ", "GR", "GT", "GU", "GW", "GY", "HK", "HN", "HR", "HT", "HU", "ID", "IE", "IL", "IM", "IN", "IO", "IQ", "IR", "IS", "IT", "JE", "JM", "JO", "JP", "KE", "KG", "KH", "KI", "KM", "KN", "KP", "KR", "KW", "KY", "KZ", "LA", "LB", "LC", "LI", "LK", "LR", "LS", "LT", "LU", "LV", "LY", "MA", "MC", "MD", "ME", "MF", "MG", "MH", "MK", "ML", "MM", "MN", "MO", "MP", "MQ", "MR", "MS", "MT", "MU", "MV", "MW", "MX", "MY", "MZ", "NA", "NC", "NE", "NF", "NG", "NI", "NL", "NO", "NP", "NR", "NU", "NZ", "OM", "PA", "PE", "PF", "PG", "PH", "PK", "PL", "PM", "PR", "PS", "PT", "PW", "PY", "QA", "RE", "RO", "RS", "RU", "RW", "SA", "SB", "SC", "SD", "SE", "SG", "SH", "SI", "SJ", "SK", "SL", "SM", "SN", "SO", "SR", "SS", "ST", "SV", "SX", "SY", "SZ", "TA", "TC", "TD", "TG", "TH", "TJ", "TK", "TL", "TM", "TN", "TO", "TR", "TT", "TV", "TW", "TZ", "UA", "UG", "UY", "UZ", "VA", "VC", "VE", "VG", "VI", "VN", "VU", "WF", "WS", "XK", "YE", "YT", "ZA", "ZM", "ZW" ] } } ] } }, "required": ["phoneNumber"] } } } }, "parameters": [] } }, "/generate_content": { "post": { "operationId": "postIndex1", "tags": ["Generate Content"], "summary": "Generate Content", "description": "Parse any HTML or text into our multi-channel messaging schema", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "content": { "type": "object", "description": "The generated content" } }, "required": ["content"] } } }, "description": "Decoded JWT payload" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "statusCode": { "type": "number" } }, "required": ["code", "message", "statusCode"] } } }, "description": "Invalid input provided" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "anyOf": [ { "type": "object", "properties": { "html": { "type": "string", "description": "The HTML to be converted" } }, "required": ["html"] }, { "type": "object", "properties": { "text": { "type": "string", "description": "The text to be converted" }, "formatter": { "description": "The formatter to use for the text conversion", "type": "string", "enum": [ "email", "sms", "whatsapp", "instagram", "facebook", "google_business_messaging" ] } }, "required": ["text"] } ] } } } }, "parameters": [] } }, "/send_broadcast": { "post": { "operationId": "postIndex2", "tags": ["Send Broadcast"], "summary": "Send Broadcast Message", "description": "Send a Broadcast message to a list of recipients and / or segments", "responses": { "200": { "content": { "application/vnd.pgrst.object+json": { "schema": { "type": "object", "properties": { "sendout_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The ID of the sendout that has been sent" } }, "required": ["sendout_id"] } } }, "description": "The broadcast was sent successfully" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "statusCode": { "type": "number" } }, "required": ["code", "message", "statusCode"] } } }, "description": "Invalid input" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "attachment": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Attachment URL. Can either https:// or media_library://" }, "from": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The channel the broadcast is sent from" }, "template_id": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "The template to use for the broadcast" }, "require_marketing_opt_in": { "default": true, "description": "Whether the recipients must have opted in to marketing messages", "type": "boolean" }, "to_recipients": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "contact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "handle": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "placeholder_values": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "contact_external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_secondary_external_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } } } }, { "type": "null" } ], "description": "The list of recipients to send the broadcast to" }, "to_segments": { "anyOf": [ { "type": "array", "items": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" } }, { "type": "null" } ], "description": "The list of segments to send the broadcast to" }, "send_after": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ], "description": "The time to send the broadcast after" }, "placeholder_values": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Placeholder values" }, "marketing_channel_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "Marketing Channel ID" }, "review_channel_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "Review Channel ID" } }, "required": ["from", "template_id"] } } } }, "parameters": [] } }, "/send_message": { "post": { "operationId": "postIndex3", "tags": ["Send Message"], "summary": "Send Message", "description": "Send a message", "responses": { "200": { "content": { "application/vnd.pgrst.object+json": { "schema": { "type": "object", "properties": { "conversation": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "organisation_id": { "type": "string" }, "subject": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "assignee_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "unread": { "anyOf": [{ "type": "boolean" }, { "type": "null" }] }, "channel_id": { "type": "string" }, "contact_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "external_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "is_spam": { "type": "boolean" }, "inbox_id": { "type": "string" }, "latest_message_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "latest_inbound_message_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "latest_message_created_at": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "latest_inbound_message_created_at": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "tags": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ] }, "files": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": {}, "additionalProperties": {} } }, { "type": "null" } ] }, "channel_type": { "type": "string", "enum": [ "email", "sms", "whatsapp", "facebook", "instagram", "google_business_messaging" ] }, "status": { "type": "string", "enum": ["open", "closed", "archived"] } }, "required": [ "id", "created_at", "updated_at", "organisation_id", "subject", "assignee_id", "unread", "channel_id", "contact_id", "external_id", "is_spam", "inbox_id", "latest_message_id", "latest_inbound_message_id", "latest_message_created_at", "latest_inbound_message_created_at", "tags", "files", "channel_type", "status" ] }, "message": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "organisation_id": { "type": "string" }, "conversation_id": { "type": "string" }, "is_inbound": { "type": "boolean" }, "subject": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "blurb": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "author_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "content": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "raw_content": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "status": { "type": "string", "enum": [ "sent", "sending_error", "bounce_error", "submission_error", "submitted", "sending", "read", "draft", "scheduled", "interacted" ] }, "attachment_count": { "anyOf": [{ "type": "number" }, { "type": "null" }] }, "reply_to_message_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "external_files": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "external_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "template_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "review_channel_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "author_type": { "anyOf": [ { "type": "string", "enum": ["employee", "bot", "external"] }, { "type": "null" } ] }, "forwarded": { "anyOf": [{ "type": "boolean" }, { "type": "null" }] }, "forwarded_message_text": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "send_after": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "footer": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "sendout_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "campaign_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "sent_at": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "timestamp": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "location": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "location_metadata": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "contacts": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "files": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ] }, "header_media_filename": { "anyOf": [{ "type": "string" }, { "type": "null" }] } }, "required": [ "id", "created_at", "updated_at", "organisation_id", "conversation_id", "is_inbound", "subject", "blurb", "author_id", "content", "raw_content", "status", "attachment_count", "reply_to_message_id", "external_files", "external_id", "template_id", "review_channel_id", "author_type", "forwarded", "forwarded_message_text", "send_after", "footer", "sendout_id", "campaign_id", "sent_at", "timestamp", "location", "location_metadata", "contacts", "files", "header_media_filename" ] }, "recipients": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "organisation_id": { "type": "string" }, "conversation_id": { "type": "string" }, "message_id": { "type": "string" }, "contact_id": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "handle": { "type": "string" }, "full_name": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "is_organisation": { "anyOf": [{ "type": "boolean" }, { "type": "null" }] }, "role": { "type": "string", "enum": ["from", "to", "cc", "bcc", "reply_to"] }, "status": { "type": "string", "enum": [ "sent", "sending_error", "bounce_error", "submission_error", "submitted", "sending", "read", "draft", "scheduled", "interacted" ] } }, "required": [ "id", "created_at", "updated_at", "organisation_id", "conversation_id", "message_id", "contact_id", "handle", "full_name", "is_organisation", "role", "status" ] } }, "actions": { "type": "array", "items": { "type": "object", "properties": { "id": { "type": "string" }, "created_at": { "type": "string" }, "updated_at": { "type": "string" }, "organisation_id": { "type": "string" }, "conversation_id": { "type": "string" }, "message_id": { "type": "string" }, "text": { "type": "string" }, "data": { "anyOf": [{ "type": "string" }, { "type": "null" }] }, "clicked": { "type": "boolean" }, "type": { "type": "string", "enum": ["quick_reply", "call_to_action", "list"] }, "subtype": { "type": "string", "enum": ["url", "phone_number"] } }, "required": [ "id", "created_at", "updated_at", "organisation_id", "conversation_id", "message_id", "text", "data", "clicked", "type", "subtype" ] } } }, "required": [ "conversation", "message", "recipients", "actions" ] } } }, "description": "The message was sent successfully" }, "400": { "content": { "application/json": { "schema": { "type": "object", "properties": { "code": { "type": "string" }, "message": { "type": "string" }, "hint": { "type": "string" }, "statusCode": { "type": "number" } }, "required": ["code", "message", "statusCode"] } } }, "description": "Invalid input" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "from": { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$", "description": "Channel ID from which the message will be sent" }, "id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "Message ID" }, "conversation_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "Conversation ID" }, "conversation_status": { "anyOf": [ { "type": "string", "enum": ["open", "closed", "archived"] }, { "type": "null" } ], "description": "Conversation Status" }, "to": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "handle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, { "type": "null" } ] }, "country_codes": { "type": "array", "items": { "type": "string" } }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "external_contact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "secondary_external_contact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "description": "A recipient of the message" } }, { "type": "null" } ], "description": "To Recipients of the message" }, "cc": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "handle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, { "type": "null" } ] }, "country_codes": { "type": "array", "items": { "type": "string" } }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "external_contact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "secondary_external_contact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "description": "A recipient of the message" } }, { "type": "null" } ], "description": "CC Recipients of the message" }, "bcc": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "handle": { "anyOf": [ { "anyOf": [ { "type": "string" }, { "type": "array", "items": { "type": "string" } } ] }, { "type": "null" } ] }, "country_codes": { "type": "array", "items": { "type": "string" } }, "full_name": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "contact_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ] }, "external_contact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "secondary_external_contact_id": { "anyOf": [ { "type": "string" }, { "type": "null" } ] } }, "description": "A recipient of the message" } }, { "type": "null" } ], "description": "BCC Recipients of the message" }, "subject": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Subject of the message" }, "html": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "HTML content of the message" }, "text": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Text content of the message" }, "content": { "anyOf": [ { "type": "object", "properties": {}, "additionalProperties": {} }, { "type": "null" } ], "description": "Content of the message. Only use this if you know what you are doing. Prefer using html or text otherwise" }, "send_after": { "anyOf": [ { "type": "string", "format": "date-time", "pattern": "^(?:(?:\\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|([+-](?:[01]\\d|2[0-3]):[0-5]\\d)))$" }, { "type": "null" } ], "description": "Send the message after this time" }, "placeholder_values": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Placeholder values for the message" }, "reply_to_message_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "Message ID to which this message is a reply" }, "attachments": { "anyOf": [ { "type": "array", "items": { "type": "string" } }, { "type": "null" } ], "description": "Attachment URLs to the message. Can either https:// or media_library://" }, "template_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "Template ID" }, "review_channel_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "Review Channel ID" }, "marketing_channel_id": { "anyOf": [ { "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, { "type": "null" } ], "description": "Marketing Channel ID" }, "actions": { "anyOf": [ { "type": "array", "items": { "type": "object", "properties": { "data": { "anyOf": [ { "type": "string" }, { "type": "null" } ] }, "text": { "type": "string" }, "type": { "type": "string", "enum": ["quick_reply", "call_to_action", "list"] }, "subtype": { "anyOf": [ { "type": "string", "enum": ["url", "phone_number"] }, { "type": "null" } ] } }, "required": ["text", "type"] } }, { "type": "null" } ], "description": "Actions for the message, e.g. quick reply buttons" }, "footer": { "anyOf": [{ "type": "string" }, { "type": "null" }], "description": "Footer text for the message" } }, "required": ["from"] } } } }, "parameters": [] } }, "/contact_list/clear": { "post": { "operationId": "postIndex5", "tags": ["Contact List"], "summary": "Clear Contact List", "description": "Clear all members from a contact list", "responses": { "200": { "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": ["success"] } } }, "description": "Contact list cleared successfully" }, "404": { "content": { "application/json": { "schema": { "type": "object", "properties": { "message": { "type": "string" } }, "required": ["message"] } } }, "description": "Contact list not found" }, "501": { "content": { "application/json": { "schema": { "type": "object", "properties": { "success": { "type": "boolean" } }, "required": ["success"] } } }, "description": "Not implemented" } }, "requestBody": { "required": true, "content": { "application/json": { "schema": { "type": "object", "properties": { "contact_list_id": { "description": "ID of the contact list to clear", "type": "string", "format": "uuid", "pattern": "^([0-9a-fA-F]{8}-[0-9a-fA-F]{4}-[1-8][0-9a-fA-F]{3}-[89abAB][0-9a-fA-F]{3}-[0-9a-fA-F]{12}|00000000-0000-0000-0000-000000000000|ffffffff-ffff-ffff-ffff-ffffffffffff)$" }, "contact_list_external_id": { "description": "External ID of the contact list to clear", "type": "string" } } } } } }, "parameters": [] } } }, "components": { "schemas": { "segment": { "type": "object", "properties": { "id": { "type": "string", "description": "Segment ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Segment creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid", "nullable": true }, "name": { "type": "string", "description": "Name of segment", "format": "text" }, "is_default": { "type": "boolean", "description": "Is the segment set as default", "format": "boolean", "default": false } } }, "appointment": { "type": "object", "properties": { "id": { "type": "string", "description": "Appointment ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "name": { "type": "string", "description": "Name of the appointment", "format": "text" }, "description": { "type": "string", "description": "Description of the appointment", "format": "text", "nullable": true }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "status_key": { "type": "string", "description": "Status Key", "format": "text" }, "type_key": { "type": "string", "description": "Type Key", "format": "text" }, "assignee_id": { "type": "string", "description": "Assignee ID", "format": "uuid", "nullable": true }, "contact_id": { "type": "string", "description": "Contact ID", "format": "uuid" }, "start_time": { "type": "string", "description": "Start time of the appointment", "format": "timestamp with time zone" }, "end_time": { "type": "string", "description": "End time of the appointment", "format": "timestamp with time zone", "nullable": true }, "confirmed_at": { "type": "string", "description": "Confirmed at timestamp", "format": "timestamp with time zone", "nullable": true }, "cancelled_at": { "type": "string", "description": "Cancelled at timestamp", "format": "timestamp with time zone", "nullable": true }, "location_id": { "type": "string", "description": "Location ID", "format": "uuid", "nullable": true } } }, "calendar": { "type": "object", "properties": { "id": { "type": "string", "description": "Calendar ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "name": { "type": "string", "description": "Name of the calendar", "format": "text" }, "type": { "type": "string", "description": "Calendar type (virtual or provider). Only virtual calendars can be created via the API.", "format": "public.calendar_type", "enum": ["virtual", "provider"] }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true } } }, "deal": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "contact_id": { "type": "string", "description": "Contact ID", "format": "uuid" }, "name": { "type": "string", "description": "Name of the deal", "format": "text" }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "type_key": { "type": "string", "description": "Type Key", "format": "text" }, "status_key": { "type": "string", "description": "Status Key", "format": "text" }, "assignee_id": { "type": "string", "description": "Assignee ID", "format": "uuid", "nullable": true }, "value": { "type": "number", "description": "Value of the deal", "format": "numeric", "nullable": true }, "currency": { "type": "string", "description": "Currency of the deal", "format": "public.currency", "enum": ["EUR", "CHF", "USD"], "default": "EUR" }, "won_at": { "type": "string", "description": "Won at timestamp", "format": "timestamp with time zone", "nullable": true }, "lost_at": { "type": "string", "description": "Lost at timestamp", "format": "timestamp with time zone", "nullable": true } } }, "contact_custom_field": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "Contact ID", "format": "uuid" }, "custom_field_id": { "type": "string", "description": "Custom field ID", "format": "uuid" }, "created_at": { "type": "string", "description": "Contact custom field creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "key": { "type": "string", "description": "Contact custom field key", "format": "text" }, "value": { "type": "string", "description": "Value of contact custom field", "format": "text", "nullable": true }, "date_value": { "type": "string", "description": "Date value", "format": "date", "nullable": true }, "string_value": { "type": "string", "description": "String value", "format": "text", "nullable": true }, "number_value": { "type": "number", "description": "Number value", "format": "numeric", "nullable": true }, "boolean_value": { "type": "boolean", "description": "Boolean value", "format": "boolean", "nullable": true }, "datetime_value": { "type": "string", "description": "Datetime value", "format": "timestamp with time zone", "nullable": true }, "string_list_value": { "type": "array", "description": "String list value", "items": { "type": "string" }, "nullable": true } } }, "api_token": { "type": "object", "properties": { "id": { "type": "string", "description": "API token ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "API token creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "name": { "type": "string", "description": "Name of API token", "format": "text" } } }, "appointment_custom_field": { "type": "object", "properties": { "appointment_id": { "type": "string", "description": "Appointment ID", "format": "uuid" }, "custom_field_id": { "type": "string", "description": "Custom field ID", "format": "uuid" }, "created_at": { "type": "string", "description": "Appointment custom field creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "key": { "type": "string", "description": "Appointment custom field key", "format": "text", "nullable": true }, "value": { "type": "string", "description": "Value of appointment custom field", "format": "text", "nullable": true }, "date_value": { "type": "string", "description": "Date value", "format": "date", "nullable": true }, "string_value": { "type": "string", "description": "String value", "format": "text", "nullable": true }, "number_value": { "type": "number", "description": "Number value", "format": "numeric", "nullable": true }, "boolean_value": { "type": "boolean", "description": "Boolean value", "format": "boolean", "nullable": true }, "datetime_value": { "type": "string", "description": "Datetime value", "format": "timestamp with time zone", "nullable": true }, "string_list_value": { "type": "array", "description": "String list value", "items": { "type": "string" }, "nullable": true } } }, "deal_type": { "type": "object", "properties": { "id": { "type": "string", "description": "Deal type ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid", "nullable": true }, "name": { "type": "string", "description": "Name of the deal type", "format": "text" }, "key": { "type": "string", "description": "Key of the deal type", "format": "text" }, "emoji": { "type": "string", "description": "Emoji of the deal type", "format": "text", "nullable": true } } }, "event": { "type": "object", "properties": { "id": { "type": "string", "description": "Event ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Event creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "conversation_id": { "type": "string", "description": "Conversation ID", "format": "uuid" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "type": { "type": "string", "description": "Type of event", "format": "public.event_type", "enum": [ "assign", "unassign", "close", "reopen", "comment", "mention", "inbound", "outbound", "tag", "untag", "sending_error", "message_bounce_error", "submit", "subject_change", "submission_error", "read", "archive", "action_click", "inbox_change", "spam", "ham", "contact_deletion", "external_id_change", "message_reaction", "form_submission_start", "inbound_voice_call" ] }, "source_type": { "type": "string", "description": "Source type", "format": "public.event_entity_type", "enum": [ "employee", "channel", "comment", "message", "tag", "recipient", "message_action", "api_token", "service_role", "inbox", "form_submission", "cs_agent_session", "cs_agent", "voice_call" ], "nullable": true }, "target_type": { "type": "string", "description": "Target type", "format": "public.event_entity_type", "enum": [ "employee", "channel", "comment", "message", "tag", "recipient", "message_action", "api_token", "service_role", "inbox", "form_submission", "cs_agent_session", "cs_agent", "voice_call" ], "nullable": true }, "metadata": { "type": "object", "description": "Metadata of event", "format": "jsonb", "nullable": true }, "source_employee_id": { "type": "string", "description": "Source employee ID", "format": "uuid", "nullable": true }, "source_api_token_id": { "type": "string", "description": "Source API token ID", "format": "uuid", "nullable": true }, "source_comment_id": { "type": "string", "description": "Source comment ID", "format": "uuid", "nullable": true }, "source_channel_id": { "type": "string", "description": "Source channel ID", "format": "uuid", "nullable": true }, "source_recipient_id": { "type": "string", "description": "Source recipient ID", "format": "uuid", "nullable": true }, "target_employee_id": { "type": "string", "description": "Target employee ID", "format": "uuid", "nullable": true }, "target_comment_id": { "type": "string", "description": "Target comment ID", "format": "uuid", "nullable": true }, "target_message_id": { "type": "string", "description": "Target message ID", "format": "uuid", "nullable": true }, "target_tag_id": { "type": "string", "description": "Target tag ID", "format": "uuid", "nullable": true }, "target_message_action_id": { "type": "string", "description": "Target message action ID", "format": "uuid", "nullable": true }, "target_inbox_id": { "type": "string", "description": "Target inbox ID", "format": "uuid", "nullable": true } } }, "appointment_status": { "type": "object", "properties": { "id": { "type": "string", "description": "Appointment status ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid", "nullable": true }, "appointment_type_id": { "type": "string", "description": "Appointment type ID", "format": "uuid" }, "name": { "type": "string", "description": "Name of the appointment status", "format": "text" }, "type": { "type": "string", "description": "Type of the appointment status", "format": "public.appointment_status_type", "enum": ["confirmed", "pending", "cancelled"] }, "key": { "type": "string", "description": "Key of the appointment status", "format": "text" } } }, "marketing_subscription": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "Contact ID", "format": "uuid" }, "marketing_channel_id": { "type": "string", "description": "Marketing channel ID", "format": "uuid" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "created_at": { "type": "string", "description": "Marketing subscription creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "key": { "type": "string", "description": "Marketing subscription key", "format": "text" }, "status": { "type": "string", "description": "Status of Marketing subscription", "format": "public.marketing_subscription_status", "enum": ["requested", "accepted", "declined"] }, "channel_type": { "type": "string", "description": "Channel Type of Conversation", "format": "public.channel_type", "enum": [ "email", "sms", "whatsapp", "instagram", "facebook", "google_business_messaging", "postal" ] } } }, "message": { "type": "object", "properties": { "id": { "type": "string", "description": "Message ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Message creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "conversation_id": { "type": "string", "description": "Conversation ID", "format": "uuid" }, "is_inbound": { "type": "boolean", "description": "Is the message inbound?", "format": "boolean", "default": false }, "subject": { "type": "string", "description": "Subject of message", "format": "text", "nullable": true }, "author_id": { "type": "string", "description": "Author ID", "format": "uuid", "nullable": true }, "content": { "type": "object", "description": "Content of message", "format": "jsonb", "nullable": true }, "raw_content": { "type": "string", "description": "Raw content of message", "format": "text", "nullable": true }, "status": { "type": "string", "description": "Status of message", "format": "public.recipient_status", "enum": [ "sent", "sending_error", "bounce_error", "submission_error", "submitted", "sending", "read", "draft", "scheduled", "interacted", "answered" ], "nullable": true }, "attachment_count": { "type": "integer", "description": "Attachment count of message", "format": "integer", "nullable": true }, "reply_to_message_id": { "type": "string", "description": "Reply to message ID", "format": "uuid", "nullable": true }, "external_files": { "type": "object", "description": "External files of message", "format": "jsonb", "nullable": true }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "template_id": { "type": "string", "description": "Template ID", "format": "uuid", "nullable": true }, "review_channel_id": { "type": "string", "description": "Review Channel ID", "format": "uuid", "nullable": true }, "author_type": { "type": "string", "description": "Author type of message", "format": "public.author_type", "enum": ["employee", "bot", "external"], "nullable": true }, "forwarded": { "type": "boolean", "description": "Is message forwarded?", "format": "boolean", "default": false }, "forwarded_message_text": { "type": "string", "description": "Forwarded Message text", "format": "text", "nullable": true }, "send_after": { "type": "string", "description": "Message send after", "format": "timestamp with time zone", "nullable": true }, "footer": { "type": "string", "description": "Message footer", "format": "text", "nullable": true }, "sendout_id": { "type": "string", "description": "Sendout ID", "format": "uuid", "nullable": true }, "campaign_id": { "type": "string", "description": "Campaign ID", "format": "uuid", "nullable": true }, "sent_at": { "type": "string", "description": "Message sent at", "format": "timestamp with time zone", "nullable": true }, "timestamp": { "type": "string", "description": "Timestamp of message", "format": "timestamp with time zone", "nullable": true }, "location": { "type": "string", "description": "Coordinates that are shared via chat", "format": "extensions.geography(Point,4326)", "nullable": true }, "location_metadata": { "type": "object", "description": "Location metadata of message", "format": "jsonb", "nullable": true }, "contacts": { "type": "object", "description": "Contacts of message", "format": "jsonb", "nullable": true }, "files": { "type": "object", "description": "Files shared with the message", "format": "jsonb", "nullable": true }, "header_media_filename": { "type": "string", "description": "Header media filename of message", "format": "text", "nullable": true } } }, "channel": { "type": "object", "properties": { "id": { "type": "string", "description": "Channel ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Channel creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "type": { "type": "string", "description": "Channel type", "format": "public.channel_type", "enum": [ "email", "sms", "whatsapp", "instagram", "facebook", "google_business_messaging", "postal" ] }, "name": { "type": "string", "description": "Name of channel", "format": "text", "nullable": true }, "handle": { "type": "string", "description": "Channel handle", "format": "text", "nullable": true }, "status": { "type": "string", "description": "Status of channel", "format": "public.channel_status", "enum": ["draft", "in-review", "rejected", "active", "inactive"] }, "active": { "type": "boolean", "description": "Is channel active?", "format": "boolean", "nullable": true } } }, "custom_field": { "type": "object", "properties": { "id": { "type": "string", "description": "Custom field ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Custom field creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid", "nullable": true }, "name": { "type": "string", "description": "Name of custom field", "format": "text" }, "description": { "type": "string", "description": "Custom field description", "format": "text", "nullable": true }, "type": { "type": "string", "description": "Typ of custom field", "format": "public.field_type", "enum": [ "string", "datetime", "boolean", "number", "date", "string_list" ] }, "key": { "type": "string", "description": "Custom field key", "format": "text" }, "entity": { "type": "string", "format": "public.custom_field_entity", "enum": ["contact", "deal", "appointment"], "default": "contact" } } }, "tag": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "format": "uuid" }, "name": { "type": "string", "format": "text" }, "description": { "type": "string", "format": "text", "nullable": true }, "color": { "type": "string", "format": "text" } } }, "custom_entity": { "type": "object", "properties": { "id": { "type": "string", "description": "Entity ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "custom_entity_definition_id": { "type": "string", "description": "Custom entity definition ID", "format": "uuid" }, "contact_id": { "type": "string", "description": "Contact ID", "format": "uuid" }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "data": { "type": "object", "description": "Entity data matching the custom entity definition schema", "format": "jsonb" } } }, "appointment_type": { "type": "object", "properties": { "id": { "type": "string", "description": "Appointment type ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid", "nullable": true }, "name": { "type": "string", "description": "Name of the appointment type", "format": "text" }, "key": { "type": "string", "description": "Key of the appointment type", "format": "text" }, "emoji": { "type": "string", "description": "Emoji of the appointment type", "format": "text", "nullable": true }, "description": { "type": "string", "description": "Description of the appointment type", "format": "text", "nullable": true }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true } } }, "deal_custom_field": { "type": "object", "properties": { "deal_id": { "type": "string", "description": "Deal ID", "format": "uuid" }, "custom_field_id": { "type": "string", "description": "Custom field ID", "format": "uuid" }, "created_at": { "type": "string", "description": "Deal custom field creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "key": { "type": "string", "description": "Deal custom field key", "format": "text", "nullable": true }, "value": { "type": "string", "description": "Value of deal custom field", "format": "text", "nullable": true }, "date_value": { "type": "string", "description": "Date value", "format": "date", "nullable": true }, "string_value": { "type": "string", "description": "String value", "format": "text", "nullable": true }, "number_value": { "type": "number", "description": "Number value", "format": "numeric", "nullable": true }, "boolean_value": { "type": "boolean", "description": "Boolean value", "format": "boolean", "nullable": true }, "datetime_value": { "type": "string", "description": "Datetime value", "format": "timestamp with time zone", "nullable": true }, "string_list_value": { "type": "array", "description": "String list value", "items": { "type": "string" }, "nullable": true } } }, "review_channel": { "type": "object", "properties": { "id": { "type": "string", "description": "Review channel ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Review channel creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "name": { "type": "string", "description": "Name of review channel", "format": "text", "nullable": true }, "type": { "type": "string", "description": "Type of review channel", "format": "public.review_channel_type", "enum": ["google-my-business"] } } }, "contact_list_contact": { "type": "object", "properties": { "contact_id": { "type": "string", "description": "Contact ID", "format": "uuid" }, "contact_list_id": { "type": "string", "description": "Contact List ID", "format": "uuid" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" } } }, "contact_note": { "type": "object", "properties": { "id": { "type": "string", "description": "Contact note ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Contact note creation date", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "contact_id": { "type": "string", "description": "Contact ID", "format": "uuid" }, "text": { "type": "string", "description": "Text of contact note", "format": "text", "nullable": true }, "created_by_id": { "type": "string", "description": "Contact note created by ID", "format": "uuid", "nullable": true } } }, "template": { "type": "object", "properties": { "id": { "type": "string", "description": "Template ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Template creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid", "nullable": true }, "name": { "type": "string", "description": "Name of template", "format": "text" }, "subject": { "type": "string", "description": "Subject of template", "format": "text", "nullable": true }, "content": { "type": "object", "description": "Content of template", "format": "jsonb", "nullable": true }, "text": { "type": "string", "description": "Text representation of the template content", "format": "text", "nullable": true }, "request_approvals": { "type": "boolean", "description": "Request approvals of template", "format": "boolean", "nullable": true }, "language": { "maxLength": 2, "type": "string", "description": "Language of template", "format": "character varying" }, "key": { "type": "string", "description": "Template key", "format": "text" }, "footer": { "type": "string", "description": "Footer of template", "format": "text", "nullable": true }, "type": { "type": "string", "description": "Type of template", "format": "public.template_type", "enum": [ "review_request", "auto_responder", "opt_in_request", "transactional", "marketing", "opt_out_confirmation", "double_opt_in_confirmation" ] }, "buttons": { "type": "object", "description": "Buttons of template", "format": "jsonb", "nullable": true }, "header_media_filename": { "type": "string", "description": "Header media filename of template", "format": "text", "nullable": true } } }, "deal_status": { "type": "object", "properties": { "id": { "type": "string", "description": "Deal status ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid", "nullable": true }, "deal_type_id": { "type": "string", "description": "Deal type ID", "format": "uuid" }, "idx": { "type": "integer", "description": "Index of the deal", "format": "integer" }, "name": { "type": "string", "description": "Name of the deal", "format": "text" }, "type": { "type": "string", "description": "Type of the deal", "format": "public.deal_status_type", "enum": ["open", "in_progress", "won", "lost"] }, "key": { "type": "string", "description": "Key of the deal", "format": "text" } } }, "message_action": { "type": "object", "properties": { "id": { "type": "string", "description": "Message action ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Message action creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "conversation_id": { "type": "string", "description": "Conversation ID", "format": "uuid" }, "message_id": { "type": "string", "description": "Message ID", "format": "uuid" }, "type": { "type": "string", "description": "Type of message action", "format": "public.message_action_type", "enum": ["quick_reply", "call_to_action", "list"] }, "subtype": { "type": "string", "description": "Subtype of message", "format": "public.message_action_subtype", "enum": ["url", "phone_number"], "nullable": true }, "text": { "type": "string", "description": "Text of message action", "format": "text" }, "data": { "type": "string", "description": "Data of message action", "format": "text", "nullable": true }, "clicked": { "type": "boolean", "description": "Is message action clicked?", "format": "boolean", "default": false } } }, "journey_execution": { "type": "object", "properties": { "id": { "type": "string", "description": "Journey execution ID", "format": "uuid", "default": "random uuid" }, "started_at": { "type": "string", "description": "Actual start time", "format": "timestamp with time zone", "default": "now()" }, "completed_at": { "type": "string", "description": "Completion time", "format": "timestamp with time zone", "nullable": true }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "journey_id": { "type": "string", "description": "Journey ID", "format": "uuid" }, "contact_id": { "type": "string", "description": "Contact ID", "format": "uuid" }, "status": { "type": "string", "description": "Execution status", "format": "public.journey_execution_status", "enum": [ "active", "completed", "failed", "aborted", "stopped", "rate_limited" ], "default": "active" } } }, "journey_version": { "type": "object", "properties": { "id": { "type": "string", "description": "Journey version ID", "format": "uuid", "default": "random uuid" }, "journey_id": { "type": "string", "description": "Journey ID", "format": "uuid" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid", "nullable": true }, "published": { "type": "boolean", "description": "Whether this version is published", "format": "boolean", "default": false }, "version": { "type": "integer", "description": "Version number", "format": "integer" } } }, "conversation_tag": { "type": "object", "properties": { "created_at": { "type": "string", "description": "Conversation creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "tag_id": { "type": "string", "description": "Tag ID", "format": "uuid" }, "conversation_id": { "type": "string", "description": "Conversation ID", "format": "uuid" } } }, "contact": { "type": "object", "properties": { "id": { "type": "string", "description": "Contact ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Contact creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "full_name": { "type": "string", "description": "Name of contact", "format": "text", "nullable": true }, "fts": { "type": "string", "description": "Handle of contact", "format": "tsvector", "nullable": true }, "is_blocked": { "type": "boolean", "description": "Is the contact blocked?", "format": "boolean", "default": false }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "secondary_external_id": { "type": "string", "description": "Secondary External ID", "format": "text", "nullable": true }, "birthday": { "type": "string", "description": "Birthday of the contact", "format": "date", "nullable": true }, "salutation": { "type": "string", "description": "Salutation", "format": "text", "nullable": true }, "email": { "type": "string", "description": "Email of contact", "format": "text", "nullable": true }, "sms": { "type": "string", "description": "SMS of contact", "format": "text", "nullable": true }, "whatsapp": { "type": "string", "description": "Whatsapp Number", "format": "text", "nullable": true }, "instagram": { "type": "string", "description": "Instagram", "format": "text", "nullable": true }, "facebook": { "type": "string", "description": "Facebook", "format": "text", "nullable": true }, "display_name": { "type": "string", "description": "Displayed name of contact in the Mateo app", "format": "text", "nullable": true }, "google_business_messaging": { "type": "string", "description": "Google business messaging account of contact", "format": "text", "nullable": true }, "address_line1": { "type": "string", "description": "First line of the postal address", "format": "text", "nullable": true }, "address_line2": { "type": "string", "description": "Second line of the postal address", "format": "text", "nullable": true }, "city": { "type": "string", "description": "City of the postal address", "format": "text", "nullable": true }, "zipcode": { "type": "string", "description": "Postal code or ZIP code of the address", "format": "text", "nullable": true }, "country": { "type": "string", "description": "Country of the postal address", "format": "text", "nullable": true }, "postal": { "type": "string", "description": "Postal handle or identifier for the contact", "format": "text", "nullable": true }, "number_of_marketing_opt_in_requests": { "type": "integer", "description": "Number of marketing opt in requests", "format": "integer" }, "latest_marketing_opt_in_request_sent_at": { "type": "string", "description": "Latest marketing opt in request sent at", "format": "timestamp with time zone", "nullable": true }, "campaign_messages_this_month": { "type": "integer", "description": "Campaign Messages this month", "format": "integer" }, "whatsapp_marketing_opt_in": { "type": "boolean", "description": "WhatsApp marketign opt in", "format": "boolean", "default": false }, "sms_marketing_opt_in": { "type": "boolean", "description": "SMS marketing opt in", "format": "boolean", "default": false }, "email_marketing_opt_in": { "type": "boolean", "description": "Email marketing opt in of contact", "format": "boolean", "default": false }, "facebook_marketing_opt_in": { "type": "boolean", "description": "Facebook marketing opt in", "format": "boolean", "default": false }, "instagram_marketing_opt_in": { "type": "boolean", "description": "Instagram marketing opt in", "format": "boolean", "default": false }, "google_business_messaging_marketing_opt_in": { "type": "boolean", "description": "Google business messaging marketing opt in", "format": "boolean", "default": false }, "postal_marketing_opt_in": { "type": "boolean", "description": "Postal marketing opt in status", "format": "boolean", "default": true }, "whatsapp_transactional_opt_in": { "type": "string", "description": "WhatsApp transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "sms_transactional_opt_in": { "type": "string", "description": "SMS transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "email_transactional_opt_in": { "type": "string", "description": "Email transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "facebook_transactional_opt_in": { "type": "string", "description": "Facebook transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "instagram_transactional_opt_in": { "type": "string", "description": "Instagram transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "google_business_messaging_transactional_opt_in": { "type": "string", "description": "Google business messaging transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "postal_transactional_opt_in": { "type": "string", "description": "Postal transactional opt in status", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true } } }, "conversation": { "type": "object", "properties": { "id": { "type": "string", "description": "Conversation ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Conversation creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "subject": { "type": "string", "description": "Subject of conversation", "format": "text", "nullable": true }, "status": { "type": "string", "description": "Status of conversation", "format": "public.conversation_status", "enum": ["open", "closed", "archived"], "default": "open" }, "assignee_id": { "type": "string", "description": "Assignee ID", "format": "uuid", "nullable": true }, "unread": { "type": "boolean", "description": "Is conversation on unread?", "format": "boolean", "default": false, "nullable": true }, "channel_id": { "type": "string", "description": "Channel ID", "format": "uuid" }, "channel_type": { "type": "string", "description": "Channel Type of Conversation", "format": "public.channel_type", "enum": [ "email", "sms", "whatsapp", "instagram", "facebook", "google_business_messaging", "postal" ] }, "contact_id": { "type": "string", "description": "Contact ID", "format": "uuid", "nullable": true }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "tags": { "type": "object", "description": "Given tags of conversation", "format": "jsonb", "nullable": true }, "is_spam": { "type": "boolean", "description": "Is conversation marked as spam?", "format": "boolean", "default": false }, "inbox_id": { "type": "string", "description": "Inbox ID", "format": "uuid" }, "latest_message_id": { "type": "string", "description": "Latest message ID", "format": "uuid", "nullable": true }, "latest_inbound_message_id": { "type": "string", "description": "Latest inbound message ID", "format": "uuid", "nullable": true }, "latest_message_created_at": { "type": "string", "description": "Latest message creation date", "format": "timestamp with time zone", "nullable": true }, "latest_inbound_message_created_at": { "type": "string", "description": "Latest inbound message creation date", "format": "timestamp with time zone", "nullable": true } } }, "journey": { "type": "object", "properties": { "id": { "type": "string", "description": "Journey ID", "format": "uuid", "default": "random uuid" }, "name": { "type": "string", "description": "Journey name", "format": "text" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid", "nullable": true }, "key": { "type": "string", "description": "Journey key", "format": "text", "nullable": true }, "status": { "type": "string", "description": "Journey status", "format": "public.journey_status", "enum": ["active", "inactive", "draft"], "default": "draft" }, "latest_published_version_id": { "type": "string", "description": "Latest published version ID", "format": "uuid", "nullable": true } } }, "recipient": { "type": "object", "properties": { "id": { "type": "string", "description": "Recipient ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Recipient creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "conversation_id": { "type": "string", "description": "Conversation ID", "format": "uuid" }, "message_id": { "type": "string", "description": "Message ID", "format": "uuid" }, "contact_id": { "type": "string", "description": "Contact ID", "format": "uuid", "nullable": true }, "handle": { "type": "string", "description": "Handle of recipient", "format": "text" }, "full_name": { "type": "string", "description": "Name of recipient", "format": "text", "nullable": true }, "role": { "type": "string", "description": "Role of recipient", "format": "public.recipient_role", "enum": ["from", "to", "cc", "bcc", "reply_to"], "nullable": true }, "is_organisation": { "type": "boolean", "description": "Is recipient the organisation?", "format": "boolean", "nullable": true }, "status": { "type": "string", "description": "Status of recipient", "format": "public.recipient_status", "enum": [ "sent", "sending_error", "bounce_error", "submission_error", "submitted", "sending", "read", "draft", "scheduled", "interacted", "answered" ], "nullable": true } } }, "custom_entity_definition": { "type": "object", "properties": { "id": { "type": "string", "description": "Custom entity definition ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "key": { "type": "string", "description": "Unique key for the custom entity definition", "format": "text" }, "name": { "type": "string", "description": "Name of the custom entity definition", "format": "text" }, "schema": { "type": "object", "description": "JSON Schema defining the custom entity data structure", "format": "jsonb" } } }, "contact_list": { "type": "object", "properties": { "id": { "type": "string", "description": "Contact List ID", "format": "uuid", "default": "random uuid" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid", "nullable": true }, "name": { "type": "string", "description": "Name of contact list", "format": "text" }, "created_at": { "type": "string", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "format": "timestamp with time zone", "default": "now()" } } }, "location": { "type": "object", "properties": { "id": { "type": "string", "description": "Location ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "name": { "type": "string", "description": "Name of the location", "format": "text" }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "street": { "type": "string", "description": "Street address", "format": "text", "nullable": true }, "postal_code": { "type": "string", "description": "Postal or ZIP code", "format": "text", "nullable": true }, "city": { "type": "string", "description": "City", "format": "text", "nullable": true }, "region": { "type": "string", "description": "Region or state", "format": "text", "nullable": true }, "iso_country": { "type": "string", "description": "ISO 3166-1 alpha-2 country code", "format": "text", "nullable": true }, "address_line": { "type": "string", "description": "Full formatted address line (generated)", "format": "text", "nullable": true } } }, "webhook": { "type": "object", "properties": { "id": { "type": "string", "description": "Webhook ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Webhook creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "name": { "type": "string", "description": "Name of webhook", "format": "text" }, "source": { "type": "string", "description": "Source of webhook", "format": "public.webhook_source", "enum": ["zapier", "n8n", "make", "authenticated"], "default": "(auth.role())" }, "active": { "type": "boolean", "description": "Is the webhook active?", "format": "boolean", "default": true }, "target_url": { "type": "string", "description": "Target url of webhook", "format": "text" }, "headers": { "type": "object", "description": "Header of webhook", "format": "jsonb" }, "method": { "type": "string", "description": "Webhook method", "format": "public.http_method", "enum": ["GET", "POST", "PUT", "PATCH"], "default": "POST" }, "event": { "type": "string", "description": "Event of webhook", "format": "public.webhook_event", "enum": [ "contact.created", "contact_details.updated", "contact.deleted", "conversation.inbound", "conversation.tag", "conversation.untag", "conversation.assign", "conversation.unassign", "conversation.submission_error", "conversation.sending_error", "conversation.outbound", "conversation.reopen", "conversation.close", "form_submission.completed", "form_submission.aborted", "contact.updated" ] } } }, "comment": { "type": "object", "properties": { "id": { "type": "string", "description": "Comment ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Comment creation date", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "conversation_id": { "type": "string", "description": "Conversation ID", "format": "uuid" }, "message_id": { "type": "string", "description": "Message ID", "format": "uuid", "nullable": true }, "author_id": { "type": "string", "description": "Author ID", "format": "uuid", "nullable": true }, "content": { "type": "object", "description": "Content of comment", "format": "jsonb", "nullable": true } } }, "provider": { "type": "object", "properties": { "id": { "type": "string", "description": "Provider ID", "format": "uuid", "default": "random uuid" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "created_at": { "type": "string", "description": "Provider creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "name": { "type": "string", "description": "Name of provider", "format": "text", "nullable": true }, "status": { "type": "string", "description": "Status of provider", "format": "public.provider_status", "enum": ["draft", "in-review", "rejected", "active", "inactive"] }, "type": { "type": "string", "description": "Typ of provider", "format": "public.provider_type", "enum": [ "twilio-regulatory-bundle", "meta-account", "google-account", "nylas", "360dialog-whatsapp-business-account", "meta-business", "meta-waba", "emailbrief", "twilio" ] } } }, "provider_template_approval": { "type": "object", "properties": { "provider_id": { "type": "string", "description": "Provider ID", "format": "uuid" }, "template_id": { "type": "string", "description": "Template ID", "format": "uuid" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "created_at": { "type": "string", "description": "Provider template approval creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "status": { "type": "string", "description": "Status of provider template approval", "format": "public.whatsapp_template_status", "enum": ["requested", "in_review", "approved", "rejected"] }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "rejection_reason": { "type": "string", "description": "Rejection reason of provider template approval", "format": "text", "nullable": true }, "category": { "type": "string", "description": "Category of provider template approval", "format": "text", "nullable": true } } }, "import": { "type": "object", "properties": { "id": { "type": "string", "description": "Import ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Import creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "type": { "type": "string", "description": "Type of import", "format": "public.import_type", "enum": ["contact_details", "deal_details", "appointment_details"] }, "payload": { "type": "object", "description": "Payload of import for small imports", "format": "jsonb", "nullable": true }, "contact_list_id": { "type": "string", "description": "ID of the contact list that the contacts should be assigned to", "format": "uuid", "nullable": true }, "contact_list_external_id": { "type": "string", "description": "External ID of the contact list that the contacts should be assigned to", "format": "text", "nullable": true }, "failed_url": { "type": "string", "description": "URL to download the failed contacts", "format": "text", "nullable": true }, "payload_url": { "type": "string", "description": "URL to download the payload for large imports", "format": "text", "nullable": true }, "total_count": { "type": "integer", "description": "Total number of contacts in the import", "format": "integer", "nullable": true }, "success_count": { "type": "integer", "description": "Number of contacts successfully imported", "format": "integer", "nullable": true }, "failed_count": { "type": "integer", "description": "Number of contacts that failed to import", "format": "integer", "nullable": true }, "reference_id": { "type": "string", "description": "An optional reference ID provided during the import", "format": "text", "nullable": true }, "hints": { "type": "object", "description": "Optional hints for the import, e.g. to indicate if a field was stolen from another contact. We only store the first 20 hints.", "format": "jsonb", "nullable": true }, "allow_deal_reassignment": { "type": "boolean", "description": "If true, a deal currently assigned to another contact will be re-assigned", "format": "boolean", "nullable": true }, "allow_appointment_reassignment": { "type": "boolean", "description": "If true, an appointment currently assigned to another contact will be re-assigned", "format": "boolean", "nullable": true } } }, "campaign": { "type": "object", "properties": { "id": { "type": "string", "description": "Campaign ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Campaign creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid", "nullable": true }, "name": { "type": "string", "description": "Name of campaign", "format": "text" } } }, "marketing_channel": { "type": "object", "properties": { "id": { "type": "string", "description": "Marketing channel ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Marketing channel creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid", "nullable": true }, "name": { "type": "string", "description": "Name of marketing channel", "format": "text" }, "key": { "type": "string", "description": "Marketing channel key", "format": "text" } } }, "journey_node": { "type": "object", "properties": { "id": { "type": "string", "description": "Journey node ID", "format": "uuid", "default": "random uuid" }, "journey_version_id": { "type": "string", "description": "Journey version ID", "format": "uuid" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid", "nullable": true }, "type": { "type": "string", "description": "Node type", "format": "public.journey_node_type", "enum": [ "trigger", "form", "filter", "wait_for_event", "wait_until", "wait_for_time", "send_message", "if_else", "switch", "set_conversation_status", "move_conversation_to_inbox", "set_conversation_is_spam", "set_conversation_assignee", "update_contact_list_membership", "update_conversation_tag", "add_conversation_comment", "set_contact_value", "set_deal_value", "set_appointment_value", "update_marketing_subscription", "segment_filter", "http_request" ], "nullable": true }, "event_type": { "type": "string", "description": "Event type for trigger nodes", "format": "public.journey_event_type", "enum": [ "contact_created", "contact_changed", "deal_created", "deal_changed", "appointment_created", "appointment_changed", "deal_won", "deal_lost", "appointment_confirmed", "appointment_cancelled", "message_inbound", "appointment_started", "appointment_ended", "appointment_approaching", "marketing_subscription_accepted", "date", "birthday", "message_action_click", "conversation_closed", "conversation_reopened", "http", "review_request_submitted", "review_submitted", "form_completed", "message_outbound", "message_sending_error", "custom_entity_created", "custom_entity_changed" ], "nullable": true }, "extra_context_schema": { "type": "object", "description": "Schema for additional context data", "format": "jsonb", "nullable": true }, "name": { "type": "string", "description": "Node name", "format": "text", "nullable": true } } }, "employee": { "type": "object", "properties": { "id": { "type": "string", "description": "Employee ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Employee creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "user_id": { "type": "string", "description": "User ID", "format": "uuid", "nullable": true }, "is_admin": { "type": "boolean", "description": "Is employee an admin?", "format": "boolean", "default": false, "nullable": true }, "username": { "type": "string", "description": "Name of employee", "format": "text" }, "signature": { "type": "string", "description": "Signature of employee", "format": "text", "nullable": true }, "full_name": { "type": "string", "description": "Name of employee", "format": "text", "nullable": true }, "email": { "type": "string", "description": "Email of employee", "format": "text", "nullable": true }, "display_name": { "type": "string", "description": "Displayed name of the employee in the Mateo app", "format": "text" } } }, "contact_details": { "type": "object", "properties": { "id": { "type": "string", "description": "Contact ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Contact creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "full_name": { "type": "string", "description": "Name of contact", "format": "text", "nullable": true }, "fts": { "type": "string", "description": "Handle of contact", "format": "tsvector", "nullable": true }, "is_blocked": { "type": "boolean", "description": "Is the contact blocked?", "format": "boolean", "default": false }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "secondary_external_id": { "type": "string", "description": "Secondary External ID", "format": "text", "nullable": true }, "birthday": { "type": "string", "description": "Birthday of the contact", "format": "date", "nullable": true }, "salutation": { "type": "string", "description": "Salutation", "format": "text", "nullable": true }, "email": { "type": "string", "description": "Email of contact", "format": "text", "nullable": true }, "sms": { "type": "string", "description": "SMS of contact", "format": "text", "nullable": true }, "whatsapp": { "type": "string", "description": "Whatsapp Number", "format": "text", "nullable": true }, "instagram": { "type": "string", "description": "Instagram", "format": "text", "nullable": true }, "facebook": { "type": "string", "description": "Facebook", "format": "text", "nullable": true }, "display_name": { "type": "string", "description": "Displayed name of contact in the Mateo app", "format": "text", "nullable": true }, "google_business_messaging": { "type": "string", "description": "Google business messaging account of contact", "format": "text", "nullable": true }, "address_line1": { "type": "string", "description": "First line of the postal address", "format": "text", "nullable": true }, "address_line2": { "type": "string", "description": "Second line of the postal address", "format": "text", "nullable": true }, "city": { "type": "string", "description": "City of the postal address", "format": "text", "nullable": true }, "zipcode": { "type": "string", "description": "Postal code or ZIP code of the address", "format": "text", "nullable": true }, "country": { "type": "string", "description": "Country of the postal address", "format": "text", "nullable": true }, "postal": { "type": "string", "description": "Postal handle or identifier for the contact", "format": "text", "nullable": true }, "number_of_marketing_opt_in_requests": { "type": "integer", "description": "Number of marketing opt in requests", "format": "integer" }, "latest_marketing_opt_in_request_sent_at": { "type": "string", "description": "Latest marketing opt in request sent at", "format": "timestamp with time zone", "nullable": true }, "campaign_messages_this_month": { "type": "integer", "description": "Campaign Messages this month", "format": "integer" }, "whatsapp_marketing_opt_in": { "type": "boolean", "description": "WhatsApp marketign opt in", "format": "boolean", "default": false }, "sms_marketing_opt_in": { "type": "boolean", "description": "SMS marketing opt in", "format": "boolean", "default": false }, "email_marketing_opt_in": { "type": "boolean", "description": "Email marketing opt in of contact", "format": "boolean", "default": false }, "facebook_marketing_opt_in": { "type": "boolean", "description": "Facebook marketing opt in", "format": "boolean", "default": false }, "instagram_marketing_opt_in": { "type": "boolean", "description": "Instagram marketing opt in", "format": "boolean", "default": false }, "google_business_messaging_marketing_opt_in": { "type": "boolean", "description": "Google business messaging marketing opt in", "format": "boolean", "default": false }, "postal_marketing_opt_in": { "type": "boolean", "description": "Postal marketing opt in status", "format": "boolean", "default": true }, "whatsapp_transactional_opt_in": { "type": "string", "description": "WhatsApp transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "sms_transactional_opt_in": { "type": "string", "description": "SMS transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "email_transactional_opt_in": { "type": "string", "description": "Email transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "facebook_transactional_opt_in": { "type": "string", "description": "Facebook transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "instagram_transactional_opt_in": { "type": "string", "description": "Instagram transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "google_business_messaging_transactional_opt_in": { "type": "string", "description": "Google business messaging transactional opt in", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true }, "postal_transactional_opt_in": { "type": "string", "description": "Postal transactional opt in status", "format": "public.opt_in_reason", "enum": [ "legitimate_interest", "contract_fulfillment", "consent_granted" ], "nullable": true } }, "additionalProperties": { "oneOf": [ { "type": "string", "example": "your string custom field" }, { "type": "string", "enum": ["requested", "accepted", "declined"] }, { "format": "date", "type": "string" }, { "format": "timestamp with time zone", "type": "string" }, { "type": "integer", "example": 456 }, { "type": "boolean", "example": true }, { "type": "array", "items": { "type": "string" }, "example": ["item1", "item2"] } ] } }, "deal_details": { "type": "object", "properties": { "id": { "type": "string", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "contact_id": { "type": "string", "description": "Contact ID", "format": "uuid" }, "name": { "type": "string", "description": "Name of the deal", "format": "text" }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "type_key": { "type": "string", "description": "Type Key", "format": "text" }, "status_key": { "type": "string", "description": "Status Key", "format": "text" }, "assignee_id": { "type": "string", "description": "Assignee ID", "format": "uuid", "nullable": true }, "value": { "type": "number", "description": "Value of the deal", "format": "numeric", "nullable": true }, "currency": { "type": "string", "description": "Currency of the deal", "format": "public.currency", "enum": ["EUR", "CHF", "USD"], "default": "EUR" }, "won_at": { "type": "string", "description": "Won at timestamp", "format": "timestamp with time zone", "nullable": true }, "lost_at": { "type": "string", "description": "Lost at timestamp", "format": "timestamp with time zone", "nullable": true } }, "additionalProperties": { "oneOf": [ { "type": "string", "example": "your string custom field" }, { "format": "date", "type": "string" }, { "format": "timestamp with time zone", "type": "string" }, { "type": "integer", "example": 456 }, { "type": "boolean", "example": true }, { "type": "array", "items": { "type": "string" }, "example": ["item1", "item2"] } ] } }, "appointment_details": { "type": "object", "properties": { "id": { "type": "string", "description": "Appointment ID", "format": "uuid", "default": "random uuid" }, "created_at": { "type": "string", "description": "Creation date", "format": "timestamp with time zone", "default": "now()" }, "updated_at": { "type": "string", "description": "Latest update", "format": "timestamp with time zone", "default": "now()" }, "organisation_id": { "type": "string", "description": "Organisation ID", "format": "uuid" }, "name": { "type": "string", "description": "Name of the appointment", "format": "text" }, "description": { "type": "string", "description": "Description of the appointment", "format": "text", "nullable": true }, "external_id": { "type": "string", "description": "External ID", "format": "text", "nullable": true }, "status_key": { "type": "string", "description": "Status Key", "format": "text" }, "type_key": { "type": "string", "description": "Type Key", "format": "text" }, "assignee_id": { "type": "string", "description": "Assignee ID", "format": "uuid", "nullable": true }, "contact_id": { "type": "string", "description": "Contact ID", "format": "uuid" }, "start_time": { "type": "string", "description": "Start time of the appointment", "format": "timestamp with time zone" }, "end_time": { "type": "string", "description": "End time of the appointment", "format": "timestamp with time zone", "nullable": true }, "confirmed_at": { "type": "string", "description": "Confirmed at timestamp", "format": "timestamp with time zone", "nullable": true }, "cancelled_at": { "type": "string", "description": "Cancelled at timestamp", "format": "timestamp with time zone", "nullable": true }, "location_id": { "type": "string", "description": "Location ID", "format": "uuid", "nullable": true } }, "additionalProperties": { "oneOf": [ { "type": "string", "example": "your string custom field" }, { "format": "date", "type": "string" }, { "format": "timestamp with time zone", "type": "string" }, { "type": "integer", "example": 456 }, { "type": "boolean", "example": true }, { "type": "array", "items": { "type": "string" }, "example": ["item1", "item2"] } ] } } }, "parameters": { "preferParams": { "name": "Prefer", "in": "header", "description": "Preference", "schema": { "type": "string" } }, "preferReturn": { "name": "Prefer", "in": "header", "description": "Preference", "schema": { "type": "string", "enum": ["return=representation", "return=minimal", "return=none"] } }, "preferCount": { "name": "Prefer", "in": "header", "description": "Preference", "schema": { "type": "string", "enum": ["count=none"] } }, "preferPost": { "name": "Prefer", "in": "header", "description": "Preference", "schema": { "type": "string", "enum": [ "return=representation", "return=minimal", "return=none", "resolution=ignore-duplicates", "resolution=merge-duplicates" ] } }, "select": { "name": "select", "in": "query", "description": "Filtering Columns", "schema": { "type": "string" } }, "on_conflict": { "name": "on_conflict", "in": "query", "description": "On Conflict", "schema": { "type": "string" } }, "order": { "name": "order", "in": "query", "description": "Ordering", "schema": { "type": "string" } }, "range": { "name": "Range", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string" } }, "rangeUnit": { "name": "Range-Unit", "in": "header", "description": "Limiting and Pagination", "schema": { "type": "string", "default": "items" } }, "offset": { "name": "offset", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, "limit": { "name": "limit", "in": "query", "description": "Limiting and Pagination", "schema": { "type": "string" } }, "rowFilter.segment.id": { "name": "id", "in": "query", "description": "Segment ID", "schema": { "type": "string" } }, "rowFilter.segment.created_at": { "name": "created_at", "in": "query", "description": "Segment creation date", "schema": { "type": "string" } }, "rowFilter.segment.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.segment.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.segment.name": { "name": "name", "in": "query", "description": "Name of segment", "schema": { "type": "string" } }, "rowFilter.segment.is_default": { "name": "is_default", "in": "query", "description": "Is the segment set as default", "schema": { "type": "string" } }, "rowFilter.appointment.id": { "name": "id", "in": "query", "description": "Appointment ID", "schema": { "type": "string" } }, "rowFilter.appointment.created_at": { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, "rowFilter.appointment.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.appointment.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.appointment.name": { "name": "name", "in": "query", "description": "Name of the appointment", "schema": { "type": "string" } }, "rowFilter.appointment.description": { "name": "description", "in": "query", "description": "Description of the appointment", "schema": { "type": "string" } }, "rowFilter.appointment.external_id": { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, "rowFilter.appointment.status_key": { "name": "status_key", "in": "query", "description": "Status Key", "schema": { "type": "string" } }, "rowFilter.appointment.type_key": { "name": "type_key", "in": "query", "description": "Type Key", "schema": { "type": "string" } }, "rowFilter.appointment.assignee_id": { "name": "assignee_id", "in": "query", "description": "Assignee ID", "schema": { "type": "string" } }, "rowFilter.appointment.contact_id": { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, "rowFilter.appointment.start_time": { "name": "start_time", "in": "query", "description": "Start time of the appointment", "schema": { "type": "string" } }, "rowFilter.appointment.end_time": { "name": "end_time", "in": "query", "description": "End time of the appointment", "schema": { "type": "string" } }, "rowFilter.appointment.confirmed_at": { "name": "confirmed_at", "in": "query", "description": "Confirmed at timestamp", "schema": { "type": "string" } }, "rowFilter.appointment.cancelled_at": { "name": "cancelled_at", "in": "query", "description": "Cancelled at timestamp", "schema": { "type": "string" } }, "rowFilter.appointment.location_id": { "name": "location_id", "in": "query", "description": "Location ID", "schema": { "type": "string" } }, "rowFilter.calendar.id": { "name": "id", "in": "query", "description": "Calendar ID", "schema": { "type": "string" } }, "rowFilter.calendar.created_at": { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, "rowFilter.calendar.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.calendar.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.calendar.name": { "name": "name", "in": "query", "description": "Name of the calendar", "schema": { "type": "string" } }, "rowFilter.calendar.type": { "name": "type", "in": "query", "description": "Calendar type (virtual or provider). Only virtual calendars can be created via the API.", "schema": { "type": "string" } }, "rowFilter.calendar.external_id": { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, "rowFilter.deal.id": { "name": "id", "in": "query", "schema": { "type": "string" } }, "rowFilter.deal.created_at": { "name": "created_at", "in": "query", "schema": { "type": "string" } }, "rowFilter.deal.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.deal.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.deal.contact_id": { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, "rowFilter.deal.name": { "name": "name", "in": "query", "description": "Name of the deal", "schema": { "type": "string" } }, "rowFilter.deal.external_id": { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, "rowFilter.deal.type_key": { "name": "type_key", "in": "query", "description": "Type Key", "schema": { "type": "string" } }, "rowFilter.deal.status_key": { "name": "status_key", "in": "query", "description": "Status Key", "schema": { "type": "string" } }, "rowFilter.deal.assignee_id": { "name": "assignee_id", "in": "query", "description": "Assignee ID", "schema": { "type": "string" } }, "rowFilter.deal.value": { "name": "value", "in": "query", "description": "Value of the deal", "schema": { "type": "string" } }, "rowFilter.deal.currency": { "name": "currency", "in": "query", "description": "Currency of the deal", "schema": { "type": "string" } }, "rowFilter.deal.won_at": { "name": "won_at", "in": "query", "description": "Won at timestamp", "schema": { "type": "string" } }, "rowFilter.deal.lost_at": { "name": "lost_at", "in": "query", "description": "Lost at timestamp", "schema": { "type": "string" } }, "rowFilter.contact_custom_field.contact_id": { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, "rowFilter.contact_custom_field.custom_field_id": { "name": "custom_field_id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" } }, "rowFilter.contact_custom_field.created_at": { "name": "created_at", "in": "query", "description": "Contact custom field creation date", "schema": { "type": "string" } }, "rowFilter.contact_custom_field.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.contact_custom_field.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.contact_custom_field.key": { "name": "key", "in": "query", "description": "Contact custom field key", "schema": { "type": "string" } }, "rowFilter.contact_custom_field.value": { "name": "value", "in": "query", "description": "Value of contact custom field", "schema": { "type": "string" } }, "rowFilter.contact_custom_field.date_value": { "name": "date_value", "in": "query", "description": "Date value", "schema": { "type": "string" } }, "rowFilter.contact_custom_field.string_value": { "name": "string_value", "in": "query", "description": "String value", "schema": { "type": "string" } }, "rowFilter.contact_custom_field.number_value": { "name": "number_value", "in": "query", "description": "Number value", "schema": { "type": "string" } }, "rowFilter.contact_custom_field.boolean_value": { "name": "boolean_value", "in": "query", "description": "Boolean value", "schema": { "type": "string" } }, "rowFilter.contact_custom_field.datetime_value": { "name": "datetime_value", "in": "query", "description": "Datetime value", "schema": { "type": "string" } }, "rowFilter.contact_custom_field.string_list_value": { "name": "string_list_value", "in": "query", "description": "String list value", "schema": { "type": "string" } }, "rowFilter.api_token.id": { "name": "id", "in": "query", "description": "API token ID", "schema": { "type": "string" } }, "rowFilter.api_token.created_at": { "name": "created_at", "in": "query", "description": "API token creation date", "schema": { "type": "string" } }, "rowFilter.api_token.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.api_token.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.api_token.name": { "name": "name", "in": "query", "description": "Name of API token", "schema": { "type": "string" } }, "rowFilter.appointment_custom_field.appointment_id": { "name": "appointment_id", "in": "query", "description": "Appointment ID", "schema": { "type": "string" } }, "rowFilter.appointment_custom_field.custom_field_id": { "name": "custom_field_id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" } }, "rowFilter.appointment_custom_field.created_at": { "name": "created_at", "in": "query", "description": "Appointment custom field creation date", "schema": { "type": "string" } }, "rowFilter.appointment_custom_field.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.appointment_custom_field.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.appointment_custom_field.key": { "name": "key", "in": "query", "description": "Appointment custom field key", "schema": { "type": "string" } }, "rowFilter.appointment_custom_field.value": { "name": "value", "in": "query", "description": "Value of appointment custom field", "schema": { "type": "string" } }, "rowFilter.appointment_custom_field.date_value": { "name": "date_value", "in": "query", "description": "Date value", "schema": { "type": "string" } }, "rowFilter.appointment_custom_field.string_value": { "name": "string_value", "in": "query", "description": "String value", "schema": { "type": "string" } }, "rowFilter.appointment_custom_field.number_value": { "name": "number_value", "in": "query", "description": "Number value", "schema": { "type": "string" } }, "rowFilter.appointment_custom_field.boolean_value": { "name": "boolean_value", "in": "query", "description": "Boolean value", "schema": { "type": "string" } }, "rowFilter.appointment_custom_field.datetime_value": { "name": "datetime_value", "in": "query", "description": "Datetime value", "schema": { "type": "string" } }, "rowFilter.appointment_custom_field.string_list_value": { "name": "string_list_value", "in": "query", "description": "String list value", "schema": { "type": "string" } }, "rowFilter.deal_type.id": { "name": "id", "in": "query", "description": "Deal type ID", "schema": { "type": "string" } }, "rowFilter.deal_type.created_at": { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, "rowFilter.deal_type.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.deal_type.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.deal_type.name": { "name": "name", "in": "query", "description": "Name of the deal type", "schema": { "type": "string" } }, "rowFilter.deal_type.key": { "name": "key", "in": "query", "description": "Key of the deal type", "schema": { "type": "string" } }, "rowFilter.deal_type.emoji": { "name": "emoji", "in": "query", "description": "Emoji of the deal type", "schema": { "type": "string" } }, "rowFilter.event.id": { "name": "id", "in": "query", "description": "Event ID", "schema": { "type": "string" } }, "rowFilter.event.created_at": { "name": "created_at", "in": "query", "description": "Event creation date", "schema": { "type": "string" } }, "rowFilter.event.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.event.conversation_id": { "name": "conversation_id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" } }, "rowFilter.event.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.event.type": { "name": "type", "in": "query", "description": "Type of event", "schema": { "type": "string" } }, "rowFilter.event.source_type": { "name": "source_type", "in": "query", "description": "Source type", "schema": { "type": "string" } }, "rowFilter.event.target_type": { "name": "target_type", "in": "query", "description": "Target type", "schema": { "type": "string" } }, "rowFilter.event.metadata": { "name": "metadata", "in": "query", "description": "Metadata of event", "schema": { "type": "string" } }, "rowFilter.event.source_employee_id": { "name": "source_employee_id", "in": "query", "description": "Source employee ID", "schema": { "type": "string" } }, "rowFilter.event.source_api_token_id": { "name": "source_api_token_id", "in": "query", "description": "Source API token ID", "schema": { "type": "string" } }, "rowFilter.event.source_comment_id": { "name": "source_comment_id", "in": "query", "description": "Source comment ID", "schema": { "type": "string" } }, "rowFilter.event.source_channel_id": { "name": "source_channel_id", "in": "query", "description": "Source channel ID", "schema": { "type": "string" } }, "rowFilter.event.source_recipient_id": { "name": "source_recipient_id", "in": "query", "description": "Source recipient ID", "schema": { "type": "string" } }, "rowFilter.event.target_employee_id": { "name": "target_employee_id", "in": "query", "description": "Target employee ID", "schema": { "type": "string" } }, "rowFilter.event.target_comment_id": { "name": "target_comment_id", "in": "query", "description": "Target comment ID", "schema": { "type": "string" } }, "rowFilter.event.target_message_id": { "name": "target_message_id", "in": "query", "description": "Target message ID", "schema": { "type": "string" } }, "rowFilter.event.target_tag_id": { "name": "target_tag_id", "in": "query", "description": "Target tag ID", "schema": { "type": "string" } }, "rowFilter.event.target_message_action_id": { "name": "target_message_action_id", "in": "query", "description": "Target message action ID", "schema": { "type": "string" } }, "rowFilter.event.target_inbox_id": { "name": "target_inbox_id", "in": "query", "description": "Target inbox ID", "schema": { "type": "string" } }, "rowFilter.appointment_status.id": { "name": "id", "in": "query", "description": "Appointment status ID", "schema": { "type": "string" } }, "rowFilter.appointment_status.created_at": { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, "rowFilter.appointment_status.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.appointment_status.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.appointment_status.appointment_type_id": { "name": "appointment_type_id", "in": "query", "description": "Appointment type ID", "schema": { "type": "string" } }, "rowFilter.appointment_status.name": { "name": "name", "in": "query", "description": "Name of the appointment status", "schema": { "type": "string" } }, "rowFilter.appointment_status.type": { "name": "type", "in": "query", "description": "Type of the appointment status", "schema": { "type": "string" } }, "rowFilter.appointment_status.key": { "name": "key", "in": "query", "description": "Key of the appointment status", "schema": { "type": "string" } }, "rowFilter.marketing_subscription.contact_id": { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, "rowFilter.marketing_subscription.marketing_channel_id": { "name": "marketing_channel_id", "in": "query", "description": "Marketing channel ID", "schema": { "type": "string" } }, "rowFilter.marketing_subscription.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.marketing_subscription.created_at": { "name": "created_at", "in": "query", "description": "Marketing subscription creation date", "schema": { "type": "string" } }, "rowFilter.marketing_subscription.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.marketing_subscription.key": { "name": "key", "in": "query", "description": "Marketing subscription key", "schema": { "type": "string" } }, "rowFilter.marketing_subscription.status": { "name": "status", "in": "query", "description": "Status of Marketing subscription", "schema": { "type": "string" } }, "rowFilter.marketing_subscription.channel_type": { "name": "channel_type", "in": "query", "description": "Channel Type of Conversation", "schema": { "type": "string" } }, "rowFilter.message.id": { "name": "id", "in": "query", "description": "Message ID", "schema": { "type": "string" } }, "rowFilter.message.created_at": { "name": "created_at", "in": "query", "description": "Message creation date", "schema": { "type": "string" } }, "rowFilter.message.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.message.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.message.conversation_id": { "name": "conversation_id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" } }, "rowFilter.message.is_inbound": { "name": "is_inbound", "in": "query", "description": "Is the message inbound?", "schema": { "type": "string" } }, "rowFilter.message.subject": { "name": "subject", "in": "query", "description": "Subject of message", "schema": { "type": "string" } }, "rowFilter.message.author_id": { "name": "author_id", "in": "query", "description": "Author ID", "schema": { "type": "string" } }, "rowFilter.message.content": { "name": "content", "in": "query", "description": "Content of message", "schema": { "type": "string" } }, "rowFilter.message.raw_content": { "name": "raw_content", "in": "query", "description": "Raw content of message", "schema": { "type": "string" } }, "rowFilter.message.status": { "name": "status", "in": "query", "description": "Status of message", "schema": { "type": "string" } }, "rowFilter.message.attachment_count": { "name": "attachment_count", "in": "query", "description": "Attachment count of message", "schema": { "type": "string" } }, "rowFilter.message.reply_to_message_id": { "name": "reply_to_message_id", "in": "query", "description": "Reply to message ID", "schema": { "type": "string" } }, "rowFilter.message.external_files": { "name": "external_files", "in": "query", "description": "External files of message", "schema": { "type": "string" } }, "rowFilter.message.external_id": { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, "rowFilter.message.template_id": { "name": "template_id", "in": "query", "description": "Template ID", "schema": { "type": "string" } }, "rowFilter.message.review_channel_id": { "name": "review_channel_id", "in": "query", "description": "Review Channel ID", "schema": { "type": "string" } }, "rowFilter.message.author_type": { "name": "author_type", "in": "query", "description": "Author type of message", "schema": { "type": "string" } }, "rowFilter.message.forwarded": { "name": "forwarded", "in": "query", "description": "Is message forwarded?", "schema": { "type": "string" } }, "rowFilter.message.forwarded_message_text": { "name": "forwarded_message_text", "in": "query", "description": "Forwarded Message text", "schema": { "type": "string" } }, "rowFilter.message.send_after": { "name": "send_after", "in": "query", "description": "Message send after", "schema": { "type": "string" } }, "rowFilter.message.footer": { "name": "footer", "in": "query", "description": "Message footer", "schema": { "type": "string" } }, "rowFilter.message.sendout_id": { "name": "sendout_id", "in": "query", "description": "Sendout ID", "schema": { "type": "string" } }, "rowFilter.message.campaign_id": { "name": "campaign_id", "in": "query", "description": "Campaign ID", "schema": { "type": "string" } }, "rowFilter.message.sent_at": { "name": "sent_at", "in": "query", "description": "Message sent at", "schema": { "type": "string" } }, "rowFilter.message.timestamp": { "name": "timestamp", "in": "query", "description": "Timestamp of message", "schema": { "type": "string" } }, "rowFilter.message.location": { "name": "location", "in": "query", "description": "Coordinates that are shared via chat", "schema": { "type": "string" } }, "rowFilter.message.location_metadata": { "name": "location_metadata", "in": "query", "description": "Location metadata of message", "schema": { "type": "string" } }, "rowFilter.message.contacts": { "name": "contacts", "in": "query", "description": "Contacts of message", "schema": { "type": "string" } }, "rowFilter.message.files": { "name": "files", "in": "query", "description": "Files shared with the message", "schema": { "type": "string" } }, "rowFilter.message.header_media_filename": { "name": "header_media_filename", "in": "query", "description": "Header media filename of message", "schema": { "type": "string" } }, "rowFilter.channel.id": { "name": "id", "in": "query", "description": "Channel ID", "schema": { "type": "string" } }, "rowFilter.channel.created_at": { "name": "created_at", "in": "query", "description": "Channel creation date", "schema": { "type": "string" } }, "rowFilter.channel.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.channel.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.channel.type": { "name": "type", "in": "query", "description": "Channel type", "schema": { "type": "string" } }, "rowFilter.channel.name": { "name": "name", "in": "query", "description": "Name of channel", "schema": { "type": "string" } }, "rowFilter.channel.handle": { "name": "handle", "in": "query", "description": "Channel handle", "schema": { "type": "string" } }, "rowFilter.channel.status": { "name": "status", "in": "query", "description": "Status of channel", "schema": { "type": "string" } }, "rowFilter.channel.active": { "name": "active", "in": "query", "description": "Is channel active?", "schema": { "type": "string" } }, "rowFilter.custom_field.id": { "name": "id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" } }, "rowFilter.custom_field.created_at": { "name": "created_at", "in": "query", "description": "Custom field creation date", "schema": { "type": "string" } }, "rowFilter.custom_field.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.custom_field.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.custom_field.name": { "name": "name", "in": "query", "description": "Name of custom field", "schema": { "type": "string" } }, "rowFilter.custom_field.description": { "name": "description", "in": "query", "description": "Custom field description", "schema": { "type": "string" } }, "rowFilter.custom_field.type": { "name": "type", "in": "query", "description": "Typ of custom field", "schema": { "type": "string" } }, "rowFilter.custom_field.key": { "name": "key", "in": "query", "description": "Custom field key", "schema": { "type": "string" } }, "rowFilter.custom_field.entity": { "name": "entity", "in": "query", "schema": { "type": "string" } }, "rowFilter.tag.id": { "name": "id", "in": "query", "schema": { "type": "string" } }, "rowFilter.tag.created_at": { "name": "created_at", "in": "query", "schema": { "type": "string" } }, "rowFilter.tag.updated_at": { "name": "updated_at", "in": "query", "schema": { "type": "string" } }, "rowFilter.tag.organisation_id": { "name": "organisation_id", "in": "query", "schema": { "type": "string" } }, "rowFilter.tag.name": { "name": "name", "in": "query", "schema": { "type": "string" } }, "rowFilter.tag.description": { "name": "description", "in": "query", "schema": { "type": "string" } }, "rowFilter.tag.color": { "name": "color", "in": "query", "schema": { "type": "string" } }, "rowFilter.custom_entity.id": { "name": "id", "in": "query", "description": "Entity ID", "schema": { "type": "string" } }, "rowFilter.custom_entity.created_at": { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, "rowFilter.custom_entity.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.custom_entity.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.custom_entity.custom_entity_definition_id": { "name": "custom_entity_definition_id", "in": "query", "description": "Custom entity definition ID", "schema": { "type": "string" } }, "rowFilter.custom_entity.contact_id": { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, "rowFilter.custom_entity.external_id": { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, "rowFilter.custom_entity.data": { "name": "data", "in": "query", "description": "Entity data matching the custom entity definition schema", "schema": { "type": "string" } }, "rowFilter.appointment_type.id": { "name": "id", "in": "query", "description": "Appointment type ID", "schema": { "type": "string" } }, "rowFilter.appointment_type.created_at": { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, "rowFilter.appointment_type.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.appointment_type.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.appointment_type.name": { "name": "name", "in": "query", "description": "Name of the appointment type", "schema": { "type": "string" } }, "rowFilter.appointment_type.key": { "name": "key", "in": "query", "description": "Key of the appointment type", "schema": { "type": "string" } }, "rowFilter.appointment_type.emoji": { "name": "emoji", "in": "query", "description": "Emoji of the appointment type", "schema": { "type": "string" } }, "rowFilter.appointment_type.description": { "name": "description", "in": "query", "description": "Description of the appointment type", "schema": { "type": "string" } }, "rowFilter.appointment_type.external_id": { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, "rowFilter.deal_custom_field.deal_id": { "name": "deal_id", "in": "query", "description": "Deal ID", "schema": { "type": "string" } }, "rowFilter.deal_custom_field.custom_field_id": { "name": "custom_field_id", "in": "query", "description": "Custom field ID", "schema": { "type": "string" } }, "rowFilter.deal_custom_field.created_at": { "name": "created_at", "in": "query", "description": "Deal custom field creation date", "schema": { "type": "string" } }, "rowFilter.deal_custom_field.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.deal_custom_field.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.deal_custom_field.key": { "name": "key", "in": "query", "description": "Deal custom field key", "schema": { "type": "string" } }, "rowFilter.deal_custom_field.value": { "name": "value", "in": "query", "description": "Value of deal custom field", "schema": { "type": "string" } }, "rowFilter.deal_custom_field.date_value": { "name": "date_value", "in": "query", "description": "Date value", "schema": { "type": "string" } }, "rowFilter.deal_custom_field.string_value": { "name": "string_value", "in": "query", "description": "String value", "schema": { "type": "string" } }, "rowFilter.deal_custom_field.number_value": { "name": "number_value", "in": "query", "description": "Number value", "schema": { "type": "string" } }, "rowFilter.deal_custom_field.boolean_value": { "name": "boolean_value", "in": "query", "description": "Boolean value", "schema": { "type": "string" } }, "rowFilter.deal_custom_field.datetime_value": { "name": "datetime_value", "in": "query", "description": "Datetime value", "schema": { "type": "string" } }, "rowFilter.deal_custom_field.string_list_value": { "name": "string_list_value", "in": "query", "description": "String list value", "schema": { "type": "string" } }, "rowFilter.review_channel.id": { "name": "id", "in": "query", "description": "Review channel ID", "schema": { "type": "string" } }, "rowFilter.review_channel.created_at": { "name": "created_at", "in": "query", "description": "Review channel creation date", "schema": { "type": "string" } }, "rowFilter.review_channel.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.review_channel.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.review_channel.name": { "name": "name", "in": "query", "description": "Name of review channel", "schema": { "type": "string" } }, "rowFilter.review_channel.type": { "name": "type", "in": "query", "description": "Type of review channel", "schema": { "type": "string" } }, "rowFilter.contact_list_contact.contact_id": { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, "rowFilter.contact_list_contact.contact_list_id": { "name": "contact_list_id", "in": "query", "description": "Contact List ID", "schema": { "type": "string" } }, "rowFilter.contact_list_contact.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.contact_note.id": { "name": "id", "in": "query", "description": "Contact note ID", "schema": { "type": "string" } }, "rowFilter.contact_note.created_at": { "name": "created_at", "in": "query", "description": "Contact note creation date", "schema": { "type": "string" } }, "rowFilter.contact_note.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.contact_note.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.contact_note.contact_id": { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, "rowFilter.contact_note.text": { "name": "text", "in": "query", "description": "Text of contact note", "schema": { "type": "string" } }, "rowFilter.contact_note.created_by_id": { "name": "created_by_id", "in": "query", "description": "Contact note created by ID", "schema": { "type": "string" } }, "rowFilter.template.id": { "name": "id", "in": "query", "description": "Template ID", "schema": { "type": "string" } }, "rowFilter.template.created_at": { "name": "created_at", "in": "query", "description": "Template creation date", "schema": { "type": "string" } }, "rowFilter.template.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.template.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.template.name": { "name": "name", "in": "query", "description": "Name of template", "schema": { "type": "string" } }, "rowFilter.template.subject": { "name": "subject", "in": "query", "description": "Subject of template", "schema": { "type": "string" } }, "rowFilter.template.content": { "name": "content", "in": "query", "description": "Content of template", "schema": { "type": "string" } }, "rowFilter.template.text": { "name": "text", "in": "query", "description": "Text representation of the template content", "schema": { "type": "string" } }, "rowFilter.template.request_approvals": { "name": "request_approvals", "in": "query", "description": "Request approvals of template", "schema": { "type": "string" } }, "rowFilter.template.language": { "name": "language", "in": "query", "description": "Language of template", "schema": { "type": "string" } }, "rowFilter.template.key": { "name": "key", "in": "query", "description": "Template key", "schema": { "type": "string" } }, "rowFilter.template.footer": { "name": "footer", "in": "query", "description": "Footer of template", "schema": { "type": "string" } }, "rowFilter.template.type": { "name": "type", "in": "query", "description": "Type of template", "schema": { "type": "string" } }, "rowFilter.template.buttons": { "name": "buttons", "in": "query", "description": "Buttons of template", "schema": { "type": "string" } }, "rowFilter.template.header_media_filename": { "name": "header_media_filename", "in": "query", "description": "Header media filename of template", "schema": { "type": "string" } }, "rowFilter.deal_status.id": { "name": "id", "in": "query", "description": "Deal status ID", "schema": { "type": "string" } }, "rowFilter.deal_status.created_at": { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, "rowFilter.deal_status.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.deal_status.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.deal_status.deal_type_id": { "name": "deal_type_id", "in": "query", "description": "Deal type ID", "schema": { "type": "string" } }, "rowFilter.deal_status.idx": { "name": "idx", "in": "query", "description": "Index of the deal", "schema": { "type": "string" } }, "rowFilter.deal_status.name": { "name": "name", "in": "query", "description": "Name of the deal", "schema": { "type": "string" } }, "rowFilter.deal_status.type": { "name": "type", "in": "query", "description": "Type of the deal", "schema": { "type": "string" } }, "rowFilter.deal_status.key": { "name": "key", "in": "query", "description": "Key of the deal", "schema": { "type": "string" } }, "rowFilter.message_action.id": { "name": "id", "in": "query", "description": "Message action ID", "schema": { "type": "string" } }, "rowFilter.message_action.created_at": { "name": "created_at", "in": "query", "description": "Message action creation date", "schema": { "type": "string" } }, "rowFilter.message_action.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.message_action.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.message_action.conversation_id": { "name": "conversation_id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" } }, "rowFilter.message_action.message_id": { "name": "message_id", "in": "query", "description": "Message ID", "schema": { "type": "string" } }, "rowFilter.message_action.type": { "name": "type", "in": "query", "description": "Type of message action", "schema": { "type": "string" } }, "rowFilter.message_action.subtype": { "name": "subtype", "in": "query", "description": "Subtype of message", "schema": { "type": "string" } }, "rowFilter.message_action.text": { "name": "text", "in": "query", "description": "Text of message action", "schema": { "type": "string" } }, "rowFilter.message_action.data": { "name": "data", "in": "query", "description": "Data of message action", "schema": { "type": "string" } }, "rowFilter.message_action.clicked": { "name": "clicked", "in": "query", "description": "Is message action clicked?", "schema": { "type": "string" } }, "rowFilter.journey_execution.id": { "name": "id", "in": "query", "description": "Journey execution ID", "schema": { "type": "string" } }, "rowFilter.journey_execution.started_at": { "name": "started_at", "in": "query", "description": "Actual start time", "schema": { "type": "string" } }, "rowFilter.journey_execution.completed_at": { "name": "completed_at", "in": "query", "description": "Completion time", "schema": { "type": "string" } }, "rowFilter.journey_execution.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.journey_execution.journey_id": { "name": "journey_id", "in": "query", "description": "Journey ID", "schema": { "type": "string" } }, "rowFilter.journey_execution.contact_id": { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, "rowFilter.journey_execution.status": { "name": "status", "in": "query", "description": "Execution status", "schema": { "type": "string" } }, "rowFilter.journey_version.id": { "name": "id", "in": "query", "description": "Journey version ID", "schema": { "type": "string" } }, "rowFilter.journey_version.journey_id": { "name": "journey_id", "in": "query", "description": "Journey ID", "schema": { "type": "string" } }, "rowFilter.journey_version.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.journey_version.published": { "name": "published", "in": "query", "description": "Whether this version is published", "schema": { "type": "string" } }, "rowFilter.journey_version.version": { "name": "version", "in": "query", "description": "Version number", "schema": { "type": "string" } }, "rowFilter.conversation_tag.created_at": { "name": "created_at", "in": "query", "description": "Conversation creation date", "schema": { "type": "string" } }, "rowFilter.conversation_tag.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.conversation_tag.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.conversation_tag.tag_id": { "name": "tag_id", "in": "query", "description": "Tag ID", "schema": { "type": "string" } }, "rowFilter.conversation_tag.conversation_id": { "name": "conversation_id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" } }, "rowFilter.contact.id": { "name": "id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, "rowFilter.contact.created_at": { "name": "created_at", "in": "query", "description": "Contact creation date", "schema": { "type": "string" } }, "rowFilter.contact.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.contact.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.contact.full_name": { "name": "full_name", "in": "query", "description": "Name of contact", "schema": { "type": "string" } }, "rowFilter.contact.fts": { "name": "fts", "in": "query", "description": "Handle of contact", "schema": { "type": "string" } }, "rowFilter.contact.is_blocked": { "name": "is_blocked", "in": "query", "description": "Is the contact blocked?", "schema": { "type": "string" } }, "rowFilter.contact.external_id": { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, "rowFilter.contact.secondary_external_id": { "name": "secondary_external_id", "in": "query", "description": "Secondary External ID", "schema": { "type": "string" } }, "rowFilter.contact.birthday": { "name": "birthday", "in": "query", "description": "Birthday of the contact", "schema": { "type": "string" } }, "rowFilter.contact.salutation": { "name": "salutation", "in": "query", "description": "Salutation", "schema": { "type": "string" } }, "rowFilter.contact.email": { "name": "email", "in": "query", "description": "Email of contact", "schema": { "type": "string" } }, "rowFilter.contact.sms": { "name": "sms", "in": "query", "description": "SMS of contact", "schema": { "type": "string" } }, "rowFilter.contact.whatsapp": { "name": "whatsapp", "in": "query", "description": "Whatsapp Number", "schema": { "type": "string" } }, "rowFilter.contact.instagram": { "name": "instagram", "in": "query", "description": "Instagram", "schema": { "type": "string" } }, "rowFilter.contact.facebook": { "name": "facebook", "in": "query", "description": "Facebook", "schema": { "type": "string" } }, "rowFilter.contact.display_name": { "name": "display_name", "in": "query", "description": "Displayed name of contact in the Mateo app", "schema": { "type": "string" } }, "rowFilter.contact.google_business_messaging": { "name": "google_business_messaging", "in": "query", "description": "Google business messaging account of contact", "schema": { "type": "string" } }, "rowFilter.contact.address_line1": { "name": "address_line1", "in": "query", "description": "First line of the postal address", "schema": { "type": "string" } }, "rowFilter.contact.address_line2": { "name": "address_line2", "in": "query", "description": "Second line of the postal address", "schema": { "type": "string" } }, "rowFilter.contact.city": { "name": "city", "in": "query", "description": "City of the postal address", "schema": { "type": "string" } }, "rowFilter.contact.zipcode": { "name": "zipcode", "in": "query", "description": "Postal code or ZIP code of the address", "schema": { "type": "string" } }, "rowFilter.contact.country": { "name": "country", "in": "query", "description": "Country of the postal address", "schema": { "type": "string" } }, "rowFilter.contact.postal": { "name": "postal", "in": "query", "description": "Postal handle or identifier for the contact", "schema": { "type": "string" } }, "rowFilter.contact.number_of_marketing_opt_in_requests": { "name": "number_of_marketing_opt_in_requests", "in": "query", "description": "Number of marketing opt in requests", "schema": { "type": "string" } }, "rowFilter.contact.latest_marketing_opt_in_request_sent_at": { "name": "latest_marketing_opt_in_request_sent_at", "in": "query", "description": "Latest marketing opt in request sent at", "schema": { "type": "string" } }, "rowFilter.contact.campaign_messages_this_month": { "name": "campaign_messages_this_month", "in": "query", "description": "Campaign Messages this month", "schema": { "type": "string" } }, "rowFilter.contact.whatsapp_marketing_opt_in": { "name": "whatsapp_marketing_opt_in", "in": "query", "description": "WhatsApp marketign opt in", "schema": { "type": "string" } }, "rowFilter.contact.sms_marketing_opt_in": { "name": "sms_marketing_opt_in", "in": "query", "description": "SMS marketing opt in", "schema": { "type": "string" } }, "rowFilter.contact.email_marketing_opt_in": { "name": "email_marketing_opt_in", "in": "query", "description": "Email marketing opt in of contact", "schema": { "type": "string" } }, "rowFilter.contact.facebook_marketing_opt_in": { "name": "facebook_marketing_opt_in", "in": "query", "description": "Facebook marketing opt in", "schema": { "type": "string" } }, "rowFilter.contact.instagram_marketing_opt_in": { "name": "instagram_marketing_opt_in", "in": "query", "description": "Instagram marketing opt in", "schema": { "type": "string" } }, "rowFilter.contact.google_business_messaging_marketing_opt_in": { "name": "google_business_messaging_marketing_opt_in", "in": "query", "description": "Google business messaging marketing opt in", "schema": { "type": "string" } }, "rowFilter.contact.postal_marketing_opt_in": { "name": "postal_marketing_opt_in", "in": "query", "description": "Postal marketing opt in status", "schema": { "type": "string" } }, "rowFilter.contact.whatsapp_transactional_opt_in": { "name": "whatsapp_transactional_opt_in", "in": "query", "description": "WhatsApp transactional opt in", "schema": { "type": "string" } }, "rowFilter.contact.sms_transactional_opt_in": { "name": "sms_transactional_opt_in", "in": "query", "description": "SMS transactional opt in", "schema": { "type": "string" } }, "rowFilter.contact.email_transactional_opt_in": { "name": "email_transactional_opt_in", "in": "query", "description": "Email transactional opt in", "schema": { "type": "string" } }, "rowFilter.contact.facebook_transactional_opt_in": { "name": "facebook_transactional_opt_in", "in": "query", "description": "Facebook transactional opt in", "schema": { "type": "string" } }, "rowFilter.contact.instagram_transactional_opt_in": { "name": "instagram_transactional_opt_in", "in": "query", "description": "Instagram transactional opt in", "schema": { "type": "string" } }, "rowFilter.contact.google_business_messaging_transactional_opt_in": { "name": "google_business_messaging_transactional_opt_in", "in": "query", "description": "Google business messaging transactional opt in", "schema": { "type": "string" } }, "rowFilter.contact.postal_transactional_opt_in": { "name": "postal_transactional_opt_in", "in": "query", "description": "Postal transactional opt in status", "schema": { "type": "string" } }, "rowFilter.conversation.id": { "name": "id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" } }, "rowFilter.conversation.created_at": { "name": "created_at", "in": "query", "description": "Conversation creation date", "schema": { "type": "string" } }, "rowFilter.conversation.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.conversation.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.conversation.subject": { "name": "subject", "in": "query", "description": "Subject of conversation", "schema": { "type": "string" } }, "rowFilter.conversation.status": { "name": "status", "in": "query", "description": "Status of conversation", "schema": { "type": "string" } }, "rowFilter.conversation.assignee_id": { "name": "assignee_id", "in": "query", "description": "Assignee ID", "schema": { "type": "string" } }, "rowFilter.conversation.unread": { "name": "unread", "in": "query", "description": "Is conversation on unread?", "schema": { "type": "string" } }, "rowFilter.conversation.channel_id": { "name": "channel_id", "in": "query", "description": "Channel ID", "schema": { "type": "string" } }, "rowFilter.conversation.channel_type": { "name": "channel_type", "in": "query", "description": "Channel Type of Conversation", "schema": { "type": "string" } }, "rowFilter.conversation.contact_id": { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, "rowFilter.conversation.external_id": { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, "rowFilter.conversation.tags": { "name": "tags", "in": "query", "description": "Given tags of conversation", "schema": { "type": "string" } }, "rowFilter.conversation.is_spam": { "name": "is_spam", "in": "query", "description": "Is conversation marked as spam?", "schema": { "type": "string" } }, "rowFilter.conversation.inbox_id": { "name": "inbox_id", "in": "query", "description": "Inbox ID", "schema": { "type": "string" } }, "rowFilter.conversation.latest_message_id": { "name": "latest_message_id", "in": "query", "description": "Latest message ID", "schema": { "type": "string" } }, "rowFilter.conversation.latest_inbound_message_id": { "name": "latest_inbound_message_id", "in": "query", "description": "Latest inbound message ID", "schema": { "type": "string" } }, "rowFilter.conversation.latest_message_created_at": { "name": "latest_message_created_at", "in": "query", "description": "Latest message creation date", "schema": { "type": "string" } }, "rowFilter.conversation.latest_inbound_message_created_at": { "name": "latest_inbound_message_created_at", "in": "query", "description": "Latest inbound message creation date", "schema": { "type": "string" } }, "rowFilter.journey.id": { "name": "id", "in": "query", "description": "Journey ID", "schema": { "type": "string" } }, "rowFilter.journey.name": { "name": "name", "in": "query", "description": "Journey name", "schema": { "type": "string" } }, "rowFilter.journey.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.journey.key": { "name": "key", "in": "query", "description": "Journey key", "schema": { "type": "string" } }, "rowFilter.journey.status": { "name": "status", "in": "query", "description": "Journey status", "schema": { "type": "string" } }, "rowFilter.journey.latest_published_version_id": { "name": "latest_published_version_id", "in": "query", "description": "Latest published version ID", "schema": { "type": "string" } }, "rowFilter.recipient.id": { "name": "id", "in": "query", "description": "Recipient ID", "schema": { "type": "string" } }, "rowFilter.recipient.created_at": { "name": "created_at", "in": "query", "description": "Recipient creation date", "schema": { "type": "string" } }, "rowFilter.recipient.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.recipient.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.recipient.conversation_id": { "name": "conversation_id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" } }, "rowFilter.recipient.message_id": { "name": "message_id", "in": "query", "description": "Message ID", "schema": { "type": "string" } }, "rowFilter.recipient.contact_id": { "name": "contact_id", "in": "query", "description": "Contact ID", "schema": { "type": "string" } }, "rowFilter.recipient.handle": { "name": "handle", "in": "query", "description": "Handle of recipient", "schema": { "type": "string" } }, "rowFilter.recipient.full_name": { "name": "full_name", "in": "query", "description": "Name of recipient", "schema": { "type": "string" } }, "rowFilter.recipient.role": { "name": "role", "in": "query", "description": "Role of recipient", "schema": { "type": "string" } }, "rowFilter.recipient.is_organisation": { "name": "is_organisation", "in": "query", "description": "Is recipient the organisation?", "schema": { "type": "string" } }, "rowFilter.recipient.status": { "name": "status", "in": "query", "description": "Status of recipient", "schema": { "type": "string" } }, "rowFilter.custom_entity_definition.id": { "name": "id", "in": "query", "description": "Custom entity definition ID", "schema": { "type": "string" } }, "rowFilter.custom_entity_definition.created_at": { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, "rowFilter.custom_entity_definition.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.custom_entity_definition.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.custom_entity_definition.key": { "name": "key", "in": "query", "description": "Unique key for the custom entity definition", "schema": { "type": "string" } }, "rowFilter.custom_entity_definition.name": { "name": "name", "in": "query", "description": "Name of the custom entity definition", "schema": { "type": "string" } }, "rowFilter.custom_entity_definition.schema": { "name": "schema", "in": "query", "description": "JSON Schema defining the custom entity data structure", "schema": { "type": "string" } }, "rowFilter.contact_list.id": { "name": "id", "in": "query", "description": "Contact List ID", "schema": { "type": "string" } }, "rowFilter.contact_list.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.contact_list.name": { "name": "name", "in": "query", "description": "Name of contact list", "schema": { "type": "string" } }, "rowFilter.contact_list.created_at": { "name": "created_at", "in": "query", "schema": { "type": "string" } }, "rowFilter.contact_list.updated_at": { "name": "updated_at", "in": "query", "schema": { "type": "string" } }, "rowFilter.location.id": { "name": "id", "in": "query", "description": "Location ID", "schema": { "type": "string" } }, "rowFilter.location.created_at": { "name": "created_at", "in": "query", "description": "Creation date", "schema": { "type": "string" } }, "rowFilter.location.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.location.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.location.name": { "name": "name", "in": "query", "description": "Name of the location", "schema": { "type": "string" } }, "rowFilter.location.external_id": { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, "rowFilter.location.street": { "name": "street", "in": "query", "description": "Street address", "schema": { "type": "string" } }, "rowFilter.location.postal_code": { "name": "postal_code", "in": "query", "description": "Postal or ZIP code", "schema": { "type": "string" } }, "rowFilter.location.city": { "name": "city", "in": "query", "description": "City", "schema": { "type": "string" } }, "rowFilter.location.region": { "name": "region", "in": "query", "description": "Region or state", "schema": { "type": "string" } }, "rowFilter.location.iso_country": { "name": "iso_country", "in": "query", "description": "ISO 3166-1 alpha-2 country code", "schema": { "type": "string" } }, "rowFilter.location.address_line": { "name": "address_line", "in": "query", "description": "Full formatted address line (generated)", "schema": { "type": "string" } }, "rowFilter.webhook.id": { "name": "id", "in": "query", "description": "Webhook ID", "schema": { "type": "string" } }, "rowFilter.webhook.created_at": { "name": "created_at", "in": "query", "description": "Webhook creation date", "schema": { "type": "string" } }, "rowFilter.webhook.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.webhook.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.webhook.name": { "name": "name", "in": "query", "description": "Name of webhook", "schema": { "type": "string" } }, "rowFilter.webhook.source": { "name": "source", "in": "query", "description": "Source of webhook", "schema": { "type": "string" } }, "rowFilter.webhook.active": { "name": "active", "in": "query", "description": "Is the webhook active?", "schema": { "type": "string" } }, "rowFilter.webhook.target_url": { "name": "target_url", "in": "query", "description": "Target url of webhook", "schema": { "type": "string" } }, "rowFilter.webhook.headers": { "name": "headers", "in": "query", "description": "Header of webhook", "schema": { "type": "string" } }, "rowFilter.webhook.method": { "name": "method", "in": "query", "description": "Webhook method", "schema": { "type": "string" } }, "rowFilter.webhook.event": { "name": "event", "in": "query", "description": "Event of webhook", "schema": { "type": "string" } }, "rowFilter.comment.id": { "name": "id", "in": "query", "description": "Comment ID", "schema": { "type": "string" } }, "rowFilter.comment.created_at": { "name": "created_at", "in": "query", "description": "Comment creation date", "schema": { "type": "string" } }, "rowFilter.comment.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.comment.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.comment.conversation_id": { "name": "conversation_id", "in": "query", "description": "Conversation ID", "schema": { "type": "string" } }, "rowFilter.comment.message_id": { "name": "message_id", "in": "query", "description": "Message ID", "schema": { "type": "string" } }, "rowFilter.comment.author_id": { "name": "author_id", "in": "query", "description": "Author ID", "schema": { "type": "string" } }, "rowFilter.comment.content": { "name": "content", "in": "query", "description": "Content of comment", "schema": { "type": "string" } }, "rowFilter.provider.id": { "name": "id", "in": "query", "description": "Provider ID", "schema": { "type": "string" } }, "rowFilter.provider.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.provider.created_at": { "name": "created_at", "in": "query", "description": "Provider creation date", "schema": { "type": "string" } }, "rowFilter.provider.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.provider.external_id": { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, "rowFilter.provider.name": { "name": "name", "in": "query", "description": "Name of provider", "schema": { "type": "string" } }, "rowFilter.provider.status": { "name": "status", "in": "query", "description": "Status of provider", "schema": { "type": "string" } }, "rowFilter.provider.type": { "name": "type", "in": "query", "description": "Typ of provider", "schema": { "type": "string" } }, "rowFilter.provider_template_approval.provider_id": { "name": "provider_id", "in": "query", "description": "Provider ID", "schema": { "type": "string" } }, "rowFilter.provider_template_approval.template_id": { "name": "template_id", "in": "query", "description": "Template ID", "schema": { "type": "string" } }, "rowFilter.provider_template_approval.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.provider_template_approval.created_at": { "name": "created_at", "in": "query", "description": "Provider template approval creation date", "schema": { "type": "string" } }, "rowFilter.provider_template_approval.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.provider_template_approval.status": { "name": "status", "in": "query", "description": "Status of provider template approval", "schema": { "type": "string" } }, "rowFilter.provider_template_approval.external_id": { "name": "external_id", "in": "query", "description": "External ID", "schema": { "type": "string" } }, "rowFilter.provider_template_approval.rejection_reason": { "name": "rejection_reason", "in": "query", "description": "Rejection reason of provider template approval", "schema": { "type": "string" } }, "rowFilter.provider_template_approval.category": { "name": "category", "in": "query", "description": "Category of provider template approval", "schema": { "type": "string" } }, "rowFilter.import.id": { "name": "id", "in": "query", "description": "Import ID", "schema": { "type": "string" } }, "rowFilter.import.created_at": { "name": "created_at", "in": "query", "description": "Import creation date", "schema": { "type": "string" } }, "rowFilter.import.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.import.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.import.type": { "name": "type", "in": "query", "description": "Type of import", "schema": { "type": "string" } }, "rowFilter.import.payload": { "name": "payload", "in": "query", "description": "Payload of import for small imports", "schema": { "type": "string" } }, "rowFilter.import.contact_list_id": { "name": "contact_list_id", "in": "query", "description": "ID of the contact list that the contacts should be assigned to", "schema": { "type": "string" } }, "rowFilter.import.contact_list_external_id": { "name": "contact_list_external_id", "in": "query", "description": "External ID of the contact list that the contacts should be assigned to", "schema": { "type": "string" } }, "rowFilter.import.failed_url": { "name": "failed_url", "in": "query", "description": "URL to download the failed contacts", "schema": { "type": "string" } }, "rowFilter.import.payload_url": { "name": "payload_url", "in": "query", "description": "URL to download the payload for large imports", "schema": { "type": "string" } }, "rowFilter.import.total_count": { "name": "total_count", "in": "query", "description": "Total number of contacts in the import", "schema": { "type": "string" } }, "rowFilter.import.success_count": { "name": "success_count", "in": "query", "description": "Number of contacts successfully imported", "schema": { "type": "string" } }, "rowFilter.import.failed_count": { "name": "failed_count", "in": "query", "description": "Number of contacts that failed to import", "schema": { "type": "string" } }, "rowFilter.import.reference_id": { "name": "reference_id", "in": "query", "description": "An optional reference ID provided during the import", "schema": { "type": "string" } }, "rowFilter.import.hints": { "name": "hints", "in": "query", "description": "Optional hints for the import, e.g. to indicate if a field was stolen from another contact. We only store the first 20 hints.", "schema": { "type": "string" } }, "rowFilter.import.allow_deal_reassignment": { "name": "allow_deal_reassignment", "in": "query", "description": "If true, a deal currently assigned to another contact will be re-assigned", "schema": { "type": "string" } }, "rowFilter.import.allow_appointment_reassignment": { "name": "allow_appointment_reassignment", "in": "query", "description": "If true, an appointment currently assigned to another contact will be re-assigned", "schema": { "type": "string" } }, "rowFilter.campaign.id": { "name": "id", "in": "query", "description": "Campaign ID", "schema": { "type": "string" } }, "rowFilter.campaign.created_at": { "name": "created_at", "in": "query", "description": "Campaign creation date", "schema": { "type": "string" } }, "rowFilter.campaign.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.campaign.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.campaign.name": { "name": "name", "in": "query", "description": "Name of campaign", "schema": { "type": "string" } }, "rowFilter.marketing_channel.id": { "name": "id", "in": "query", "description": "Marketing channel ID", "schema": { "type": "string" } }, "rowFilter.marketing_channel.created_at": { "name": "created_at", "in": "query", "description": "Marketing channel creation date", "schema": { "type": "string" } }, "rowFilter.marketing_channel.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.marketing_channel.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.marketing_channel.name": { "name": "name", "in": "query", "description": "Name of marketing channel", "schema": { "type": "string" } }, "rowFilter.marketing_channel.key": { "name": "key", "in": "query", "description": "Marketing channel key", "schema": { "type": "string" } }, "rowFilter.journey_node.id": { "name": "id", "in": "query", "description": "Journey node ID", "schema": { "type": "string" } }, "rowFilter.journey_node.journey_version_id": { "name": "journey_version_id", "in": "query", "description": "Journey version ID", "schema": { "type": "string" } }, "rowFilter.journey_node.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.journey_node.type": { "name": "type", "in": "query", "description": "Node type", "schema": { "type": "string" } }, "rowFilter.journey_node.event_type": { "name": "event_type", "in": "query", "description": "Event type for trigger nodes", "schema": { "type": "string" } }, "rowFilter.journey_node.extra_context_schema": { "name": "extra_context_schema", "in": "query", "description": "Schema for additional context data", "schema": { "type": "string" } }, "rowFilter.journey_node.name": { "name": "name", "in": "query", "description": "Node name", "schema": { "type": "string" } }, "rowFilter.employee.id": { "name": "id", "in": "query", "description": "Employee ID", "schema": { "type": "string" } }, "rowFilter.employee.created_at": { "name": "created_at", "in": "query", "description": "Employee creation date", "schema": { "type": "string" } }, "rowFilter.employee.updated_at": { "name": "updated_at", "in": "query", "description": "Latest update", "schema": { "type": "string" } }, "rowFilter.employee.organisation_id": { "name": "organisation_id", "in": "query", "description": "Organisation ID", "schema": { "type": "string" } }, "rowFilter.employee.user_id": { "name": "user_id", "in": "query", "description": "User ID", "schema": { "type": "string" } }, "rowFilter.employee.is_admin": { "name": "is_admin", "in": "query", "description": "Is employee an admin?", "schema": { "type": "string" } }, "rowFilter.employee.username": { "name": "username", "in": "query", "description": "Name of employee", "schema": { "type": "string" } }, "rowFilter.employee.signature": { "name": "signature", "in": "query", "description": "Signature of employee", "schema": { "type": "string" } }, "rowFilter.employee.full_name": { "name": "full_name", "in": "query", "description": "Name of employee", "schema": { "type": "string" } }, "rowFilter.employee.email": { "name": "email", "in": "query", "description": "Email of employee", "schema": { "type": "string" } }, "rowFilter.employee.display_name": { "name": "display_name", "in": "query", "description": "Displayed name of the employee in the Mateo app", "schema": { "type": "string" } } }, "requestBodies": { "body.segment": { "description": "segment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/segment" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/segment" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/segment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/segment" } } }, "required": false }, "body.appointment": { "description": "appointment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appointment" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/appointment" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/appointment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/appointment" } } }, "required": false }, "body.calendar": { "description": "calendar", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/calendar" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/calendar" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/calendar" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/calendar" } } }, "required": false }, "body.deal": { "description": "deal", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/deal" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/deal" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/deal" } } }, "required": false }, "body.contact_custom_field": { "description": "contact_custom_field", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_custom_field" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/contact_custom_field" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/contact_custom_field" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/contact_custom_field" } } }, "required": false }, "body.api_token": { "description": "api_token", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/api_token" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/api_token" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/api_token" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/api_token" } } }, "required": false }, "body.appointment_custom_field": { "description": "appointment_custom_field", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appointment_custom_field" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/appointment_custom_field" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/appointment_custom_field" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/appointment_custom_field" } } }, "required": false }, "body.deal_type": { "description": "deal_type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal_type" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/deal_type" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/deal_type" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/deal_type" } } }, "required": false }, "body.event": { "description": "event", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/event" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/event" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/event" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/event" } } }, "required": false }, "body.appointment_status": { "description": "appointment_status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appointment_status" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/appointment_status" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/appointment_status" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/appointment_status" } } }, "required": false }, "body.marketing_subscription": { "description": "marketing_subscription", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketing_subscription" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/marketing_subscription" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/marketing_subscription" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/marketing_subscription" } } }, "required": false }, "body.message": { "description": "message", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/message" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/message" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/message" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/message" } } }, "required": false }, "body.channel": { "description": "channel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/channel" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/channel" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/channel" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/channel" } } }, "required": false }, "body.custom_field": { "description": "custom_field", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_field" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/custom_field" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/custom_field" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/custom_field" } } }, "required": false }, "body.tag": { "description": "tag", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/tag" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/tag" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/tag" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/tag" } } }, "required": false }, "body.custom_entity": { "description": "custom_entity", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_entity" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/custom_entity" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/custom_entity" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/custom_entity" } } }, "required": false }, "body.appointment_type": { "description": "appointment_type", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/appointment_type" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/appointment_type" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/appointment_type" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/appointment_type" } } }, "required": false }, "body.deal_custom_field": { "description": "deal_custom_field", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal_custom_field" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/deal_custom_field" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/deal_custom_field" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/deal_custom_field" } } }, "required": false }, "body.review_channel": { "description": "review_channel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/review_channel" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/review_channel" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/review_channel" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/review_channel" } } }, "required": false }, "body.contact_list_contact": { "description": "contact_list_contact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_list_contact" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/contact_list_contact" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/contact_list_contact" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/contact_list_contact" } } }, "required": false }, "body.contact_note": { "description": "contact_note", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_note" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/contact_note" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/contact_note" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/contact_note" } } }, "required": false }, "body.template": { "description": "template", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/template" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/template" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/template" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/template" } } }, "required": false }, "body.deal_status": { "description": "deal_status", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/deal_status" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/deal_status" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/deal_status" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/deal_status" } } }, "required": false }, "body.message_action": { "description": "message_action", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/message_action" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/message_action" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/message_action" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/message_action" } } }, "required": false }, "body.journey_execution": { "description": "journey_execution", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journey_execution" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/journey_execution" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/journey_execution" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/journey_execution" } } }, "required": false }, "body.journey_version": { "description": "journey_version", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journey_version" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/journey_version" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/journey_version" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/journey_version" } } }, "required": false }, "body.conversation_tag": { "description": "conversation_tag", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversation_tag" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/conversation_tag" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/conversation_tag" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/conversation_tag" } } }, "required": false }, "body.contact": { "description": "contact", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/contact" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/contact" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/contact" } } }, "required": false }, "body.conversation": { "description": "conversation", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/conversation" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/conversation" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/conversation" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/conversation" } } }, "required": false }, "body.journey": { "description": "journey", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journey" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/journey" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/journey" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/journey" } } }, "required": false }, "body.recipient": { "description": "recipient", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/recipient" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/recipient" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/recipient" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/recipient" } } }, "required": false }, "body.custom_entity_definition": { "description": "custom_entity_definition", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/custom_entity_definition" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/custom_entity_definition" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/custom_entity_definition" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/custom_entity_definition" } } }, "required": false }, "body.contact_list": { "description": "contact_list", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/contact_list" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/contact_list" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/contact_list" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/contact_list" } } }, "required": false }, "body.location": { "description": "location", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/location" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/location" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/location" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/location" } } }, "required": false }, "body.webhook": { "description": "webhook", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/webhook" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/webhook" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/webhook" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/webhook" } } }, "required": false }, "body.comment": { "description": "comment", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/comment" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/comment" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/comment" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/comment" } } }, "required": false }, "body.provider": { "description": "provider", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/provider" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/provider" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/provider" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/provider" } } }, "required": false }, "body.provider_template_approval": { "description": "provider_template_approval", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/provider_template_approval" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/provider_template_approval" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/provider_template_approval" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/provider_template_approval" } } }, "required": false }, "body.import": { "description": "import", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/import" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/import" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/import" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/import" } } }, "required": false }, "body.campaign": { "description": "campaign", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/campaign" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/campaign" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/campaign" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/campaign" } } }, "required": false }, "body.marketing_channel": { "description": "marketing_channel", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/marketing_channel" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/marketing_channel" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/marketing_channel" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/marketing_channel" } } }, "required": false }, "body.journey_node": { "description": "journey_node", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/journey_node" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/journey_node" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/journey_node" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/journey_node" } } }, "required": false }, "body.employee": { "description": "employee", "content": { "application/json": { "schema": { "$ref": "#/components/schemas/employee" } }, "application/vnd.pgrst.object+json;nulls=stripped": { "schema": { "$ref": "#/components/schemas/employee" } }, "application/vnd.pgrst.object+json": { "schema": { "$ref": "#/components/schemas/employee" } }, "text/csv": { "schema": { "$ref": "#/components/schemas/employee" } } }, "required": false } }, "securitySchemes": { "bearerAuth": { "type": "http", "scheme": "bearer", "bearerFormat": "JWT" } } } }