Account

In this Article:

  1. GET /apiv2/account
  2. POST /apiv2/account

This feature is only available to ECAL Partners for creating Sub-accounts linked to their Master-account.

GET /apiv2/account

Get a list of sub-accounts.

Parameter Required Description
apiKey YES The apiKey provided by ECAL and is found under Options in the Admin
apiSign YES MD5 string of all parameters signed by the SECRET

Sample GET JSON Data

Response

{
    "data": [
      {
        "publisherId": 123456,
        "email": "john@melbfc.com",
        "firstName": "John",
        "lastName": "Smith",
        "company": "Melbourne Junior FC",
        "reference": "34bdad38862e"
      },
      {
        "publisherId": 567890,
        "email": "alex@sydneyfc.com",
        "firstName": "Alex",
        "lastName": "Smith",
        "company": "Sydney Junior FC",
        "reference": "639f1eba068514"
      }
    ],
    "status": "200",
    "statusLong": "OK"
}

POST /apiv2/account

Creates a new sub-account.

Parameter Required Description
apiKey YES The apiKey provided by ECAL and is found under Options in the Admin
apiSign YES MD5 string of all parameters signed by the SECRET

Parameters

The account data must be posted as a RAW JSON string.

The list below shows the fields available:

Field Type Required Description
email string YES Account owner’s email address.
firstName string YES Account owner’s first name.
lastName string YES Account owner’s last name.
timezone string YES Account owner’s preferred timezone. Check valid timezones here.
company string YES Name of the account. This will be used as name of the Calendar to which events will be synced
phone string NO Phone no. of the primary account owner. For e.g +61400400400
industry string NO One of the following Industry:
  • Arts & Culture
  • Banking & Finance
  • Community Sports
  • Conferences & Exhibitions
  • Corporate
  • Education
  • Festivals
  • Gaming & Betting
  • Government
  • Health & Fitness
  • Media & Entertainment
  • Member Clubs
  • Professional Sports
  • Religion
  • Retail
  • Stadiums, Arenas & Venues
  • Telecommunications
  • Ticketing
  • Tourism
  • Travel
  • Other
objective string NO One of the following objectives:
  • Increase awareness of events
  • Increase attendance at events
  • Increase ticket sales
  • Increase membership
  • Increase participation
  • Better satisfy customers
  • Better communicate and engage
  • Increase tune-in to live events
  • Deliver new commerce
  • Support broadcast partners
  • Improve sales conversion
  • Support major corporate partners
  • Increase on-time payments
  • Increase customer retention (reduce churn)
  • Reduce costs / expenses
  • Collect customer data & insights
custom:reference string YES Reference/Identifier of the company account in Client’s internal system. Can be used for configuring custom feeds and workflows on account creation.
custom:companyType string NO Determines the account setup workflow (Schedules, Events) based on the type of Company.
custom:companyLogo string NO URL of the logo for the organisation. It’s displayed on the display widgets. The image can be in jpg or png format, 100px X 100px dimensions and up to 100KB in size. Uploaded images will be displayed in an aspect ratio of 1:1.
custom:scheduleLogo string NO URL of the logo for the schedule. It’s displayed on the sync widgets. The image can be in jpg or png format, 100px X 100px dimensions and up to 100KB in size. Uploaded images will be resized to an aspect ratio of 1:1.
custom:displayPrimaryColor string NO Used for personalising the widgets to organisations colours.
custom:displaySecondaryColor string NO Used for personalising the widgets to organisations colours.

Sample POST JSON Data

Request

{
    "email": "john@melbfc.com",
    "firstName": "John",
    "lastName": "Smith",
    "timezone": "Australia/Melbourne",
    "company": "Melbourne Junior FC",
    "industry": "Community Sports",
    "objective": "Increase awareness of events",
    "phone": "+61450212321",
    "custom": {
        "reference": "708fa376-fcbe-448c-b658-34bdad38862e",
        "companyType": "club",
        "companyLogo": "https://via.placeholder.com/100x100.png",
        "scheduleLogo": "https://via.placeholder.com/100x100.png",
        "displayPrimaryColor": "#3FC0C3",
        "displaySecondaryColor": "#2A4B9B"
    }
}

Response

{
  "status": "200",
  "statusLong": "OK",
  "publisherId": 52535,
  "apiKey": "c3b97ceb5f7e422abf639f1eba068514",
  "secret": "YVBua2VFVUXncWprcENGeXJ3UkVvZU1Y",
  "widgets": [
    {
      "id": "5215bef8b499921657000000",
      "type": "button",
      "name": "Default button",
      "directLink": "https://ql.e-c.al/2xc"
    },
    {
      "id": "93a4f92949434f6cb2725b35ca76ba6f",
      "type": "event",
      "name": "Default event display",
      "directLink": "https://ql.e-c.al/4rd"
    }
  ]
}