GrowthZone REST API API Reference

undefined

API Endpoint
https://app.memberzone.org
Request Content-Types: application/json
Response Content-Types: application/json
Schemes: https
Version: v1.0

Paths

CmsCommunication

POST /cmsapi/communication/sendemail

EmailModel

undefined

Request Example
{
  "FromEmailAddress": "string",
  "FromEmailAddressId": "string",
  "FromContactRelatedContactId": "string",
  "FromContactId": "string",
  "EmailRecipients": "string",
  "Cc": "string",
  "Bcc": "string",
  "Subject": "string",
  "Body": "string"
}
200 OK
EmailResultModel

OK

Response Example (200 OK) 
{
  "CommunicationStatusTypeId": "string"
}
CmsCommunication

POST /cmsapi/communication/sendtophone

SendToPhoneModel

undefined

Request Example
{
  "CarrierID": "integer",
  "Body": "string",
  "Subject": "string",
  "PhoneNumber": "string"
}
200 OK
SmsResultModel

OK

Response Example (200 OK) 
{
  "Success": "boolean"
}

Schema Definitions

EmailResultModel: object

CommunicationStatusTypeId: string
Example
{
  "CommunicationStatusTypeId": "string"
}

EmailModel: object

FromEmailAddress: string
FromEmailAddressId: string
FromContactRelatedContactId: string
FromContactId: string
EmailRecipients: string
Cc: string
Bcc: string
Subject: string
Body: string
Example
{
  "FromEmailAddress": "string",
  "FromEmailAddressId": "string",
  "FromContactRelatedContactId": "string",
  "FromContactId": "string",
  "EmailRecipients": "string",
  "Cc": "string",
  "Bcc": "string",
  "Subject": "string",
  "Body": "string"
}

SmsResultModel: object

Success: boolean
Example
{
  "Success": "boolean"
}

SendToPhoneModel: object

CarrierID: integer
Body: string
Subject: string
PhoneNumber: string
Example
{
  "CarrierID": "integer",
  "Body": "string",
  "Subject": "string",
  "PhoneNumber": "string"
}
Documentation by Spectacle