Skip to content

Latest commit

 

History

History
185 lines (119 loc) · 6.4 KB

CustomEmailsApi.md

File metadata and controls

185 lines (119 loc) · 6.4 KB
Raw

\CustomEmailsApi

All URIs are relative to https://console.jumpcloud.com/api/v2

Method HTTP request Description
CustomEmailsCreate Post /customemails Create custom email configuration
CustomEmailsDestroy Delete /customemails/{custom_email_type} Delete custom email configuration
CustomEmailsGetTemplates Get /customemail/templates List custom email templates
CustomEmailsRead Get /customemails/{custom_email_type} Get custom email configuration
CustomEmailsUpdate Put /customemails/{custom_email_type} Update custom email configuration

CustomEmailsCreate

CustomEmail CustomEmailsCreate(ctx, optional) Create custom email configuration

Create the custom email configuration for the specified custom email type. This action is only available to paying customers.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
xOrgId string Organization identifier that can be obtained from console settings.
body CustomEmail

Return type

CustomEmail

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CustomEmailsDestroy

CustomEmailsDestroy(ctx, customEmailType, optional) Delete custom email configuration

Delete the custom email configuration for the specified custom email type

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
customEmailType string
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
customEmailType string
xOrgId string Organization identifier that can be obtained from console settings.

Return type

(empty response body)

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CustomEmailsGetTemplates

[]CustomEmailTemplate CustomEmailsGetTemplates(ctx, ) List custom email templates

Get the list of custom email templates

Required Parameters

This endpoint does not need any parameter.

Return type

[]CustomEmailTemplate

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CustomEmailsRead

CustomEmail CustomEmailsRead(ctx, customEmailType, optional) Get custom email configuration

Get the custom email configuration for the specified custom email type

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
customEmailType string
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
customEmailType string
xOrgId string Organization identifier that can be obtained from console settings.

Return type

CustomEmail

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

CustomEmailsUpdate

CustomEmail CustomEmailsUpdate(ctx, customEmailType, optional) Update custom email configuration

Update the custom email configuration for the specified custom email type. This action is only available to paying customers.

Required Parameters

Name Type Description Notes
ctx context.Context context for logging, tracing, authentication, etc.
customEmailType string
optional map[string]interface{} optional parameters nil if no parameters

Optional Parameters

Optional parameters are passed through a map[string]interface{}.

Name Type Description Notes
customEmailType string
xOrgId string Organization identifier that can be obtained from console settings.
body CustomEmail

Return type

CustomEmail

Authorization

x-api-key

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]