API reference - Ortto help

Overview

The API reference section of this documentation provides detailed information for each set of endpoints of the Ortto API, along with descriptions of all valid parameters, request body fields, and response body values.

The following top-level Ortto API entities/endpoints are available:

NOTE: Ortto customers who have their instance region set to Australia or Europe will need to use specific service endpoints relative to the region:

Australia: https://api.au.ap3api.com/
Europe: https://api.eu.ap3api.com/

For example: https://api.eu.ap3api.com/v1/<entity/endpoint>

All other Ortto users will use the default service endpoint (https://api.ap3api.com/).

API endpoints

The following is a table of all supported API endpoints as well as their corresponding reference page for additional information.

Entity	Endpoint	Description
Account	`/v1/instance-schema/get`	Retrieve the instance schema.
Activities	`/v1/activities/create`	Create activities.
Activity	`/v1/definitions/activity/create`	Create an activity definition.
Activity	`/v1/definitions/activity/delete`	Delete an activity definition.
Activity	`/v1/definitions/activity/modify`	Modify an activity definition.
Audiences	`/v1/audience/subscribe`	Subscribe to an audience.
Audiences	`/v1/audiences/get`	Retrieve audience information.
Campaign	`/v1/assets/get-html`	Retrieve HTML for an email asset.
Campaign	`/v1/assets/get-sms`	Retrieve content and details of an SMS asset.
Campaign	`/v1/campaign/calendar`	Retrieve campaigns sent in a specified period of time.
Campaign	`/v1/campaign/reports/get`	Retrieve campaign reports.
Custom Fields	`/v1/organizations/custom-field/create`	Create a custom field for an organization.
Custom Fields	`/v1/organizations/custom-field/get`	Retrieve custom fields for an organization.
Custom Fields	`/v1/organizations/custom-field/update`	Update a custom field for an organization.
Custom Fields	`/v1/person/custom-field/create`	Create a person custom field.
Custom Fields	`/v1/person/custom-field/get`	Retrieve person custom fields.
Custom Fields	`/v1/person/custom-field/update`	Update a person custom field.
Knowledge Base	`/v1/kb/get-articles`	Retrieve a list of knowledge base articles.
Knowledge Base	`/v1/kb/get-one-article`	Retrieve a specific knowledge base article.
Organizations	`/v1/organizations/archive`	Archive organizations.
Organizations	`/v1/organizations/contacts/add`	Add contacts to an organization.
Organizations	`/v1/organizations/contacts/remove`	Remove contacts from an organization.
Organizations	`/v1/organizations/delete`	Delete organizations.
Organizations	`/v1/organizations/get`	Retrieve organizations.
Organizations	`/v1/organizations/get-by-ids`	Retrieve organizations by their IDs.
Organizations	`/v1/organizations/merge`	Create or update one or more organizations.
Organizations	`/v1/organizations/restore`	Restore archived organizations.
Person	`/v1/person/archive`	Archive contacts.
Person	`/v1/person/delete`	Delete contacts.
Person	`/v1/person/get`	Retrieve contacts.
Person	`/v1/person/get-by-ids`	Retrieve contacts by their IDs.
Person	`/v1/person/merge`	Create or update one or more people.
Person	`/v1/person/restore`	Restore archived contacts.
Person	`/v1/person/subscriptions`	Retrieve contact subscriptions.
Person	`/v1/person/get/activities`	Retrieve activity feed for a given contact.
Tags	`/v1/tags/get`	Retrieve tags.
Talk	`/v1/talk/compose`	Compose a talk session.
Talk	`/v1/talk/session`	Create a new Talk conversation.
Transactional	`/v1/transactional/send`	Send a transactional email.
Transactional	`/v1/transactional/send-sms`	Send a transactional SMS.

Talk methods

The methods and events available to programmatically control the Talk messenger widget are described at Talk JavaScript API.