reteach Rest API Documentation OIH Connector

Description

A generated OIH connector for the reteach Rest API Documentation API (version 1.0).

Generated from: https://api.reteach.io/docs-json
Generated at: 2022-12-09T17:10:37+01:00

API Description

This document describes all endpoints of the reteach Rest API. To use them, you have to obtain a bearer token for your reteach account.
The OpenAPI Specification of the API can be found here.

Authorization

Supported authorization schemes:

• Bearer Token

Actions

Updates a single tag

Tags: Tag

Input Parameters

• tagIdOrName - required - Either the id or the name of the tag
  

Triggers an email invitation for a customer

Tags: Customer

Input Parameters

• customerIdentifier - required - Either the id, the email, or the username of the customer
  

Retrieves a single e-commerce order

Tags: Order

Input Parameters

• orderId - required - The id of the e-commerce order
  

Finds or creates a single customer

Tags: Customer

Creates a single course

Tags: Course

Retrieves a single course

Tags: Course

Input Parameters

• courseId - required - The id of the course
  

Retrieves a single participation

Tags: Participation

Input Parameters

• participationId - required - The id of the participation
  

Assigns a customer to a tag and creates the tag if it does not exist

Tags: Tag

Input Parameters

• customerIdentifier - required - Either the id, the email, or the username of the customer
  

Deletes a single tag

Tags: Tag

Input Parameters

• tagIdOrName - required - Either the id or the name of the tag
  

Removes a tag from a customer by customerIdentifier (id, email, or username) and tag

Tags: Tag

Input Parameters

• customerIdentifier - required - Either the id, the email, or the username of the customer
  
• tagIdOrName - required - Either the id or the name of the tag
  

Creates a single customer export

Tags: CustomerExport

Triggers an email course invitation for a customer

Tags: Participation

Input Parameters

• participationId - required - The id of the participation
  

Assigns multiple tags to a customer. Tags will be created if they do not exist.

Tags: Tag

Input Parameters

• customerIdentifier - required - Either the id, the email, or the username of the customer
  

Retrieves a single webhook by id

Tags: Webhook

Input Parameters

• subscriptionId - required - The id of the subscription
  

Deletes a single webhook by id

Tags: Webhook

Input Parameters

• subscriptionId - required - The id of the subscription
  

Creates a webhook

Tags: Webhook

Retrieves a single course invitation

Tags: CourseInvitation

Input Parameters

• courseInvitationId - required - The id of the course invitation
  

Finds or creates a single tag

Tags: Tag

Creates a single course invitation

Tags: CourseInvitation

Retrieves a single customer export by id

Tags: CustomerExport

Input Parameters

• customerExportId - required - The id of the customer export
  

Retrieves a single customer group

Tags: CustomerGroup

Input Parameters

• customerGroupId - required - The id of the customer group
  

Triggers an email course invitation for an invitation

Tags: CourseInvitation

Input Parameters

• courseInvitationId - required - The id of the course invitation
  

Updates a single customer

Tags: Customer

Input Parameters

• customerIdentifier - required - Either the id, the email, or the username of the customer
  

Deletes a single customer group

Tags: CustomerGroup

Input Parameters

• customerGroupId - required - The id of the customer group
  

Deletes a single course invitation

Tags: CourseInvitation

Input Parameters

• courseInvitationId - required - The id of the course invitation
  

Creates a single customer group

Tags: CustomerGroup

Removes a single customer

Tags: Customer

Input Parameters

• customerIdentifier - required - Either the id, the email, or the username of the customer
  

Retrieves a single customer

Tags: Customer

Input Parameters

• customerIdentifier - required - Either the id, the email, or the username of the customer
  

License

: reteach

All files of this connector are licensed under the Apache 2.0 License. For details see the file LICENSE on the toplevel directory.