everydayhero: Developer

Invitations

Create Individual Page Invitation

Authentication types: Registered Application Token

Send an invitation to create an individual supporter page to an email address.

POST https://everydayhero.com/api/v2/individual-pages/invitations

Payload

email : required string
The email address you would like the invitation sent to. We do not tie this email address to the user’s EDH account in any way, it is only used to deliver the invitation.

phone : optional string
The phone number of the person you want to invite to create a supporter page.

full_name : optional string
The full name of the person you want to invite to create a supporter page.

charity_id : optional string
The id of the charity that you want set for this supporter page. If no charity is supplied the user will be prompted to select a charity. Defaults to none.

target : optional decimal
The amount of money this page is aiming to raise. Defaults to a predetermined value.

Example

{
  "email": "api@everydayhero.com",
  "phone": "1300798768",
  "full_name": "everydayhero Support",
  "charity_id": "au-1",
  "target": 705.5
}

Response

{
  "create_individual_page_invitation": {
    "id": 1,
    "email": "api@everydayhero.com",
    "accepted_at": null,
    "cancelled_at": null
  }
}

Create Join a Team Invitation

Authentication types: Registered Application Token

Send an invitation to create an individual supporter page for a team to an email address.

POST https://everydayhero.com/api/v2/team-pages/:team_page_id/invitations

Payload

email : required string
The email address you would like the invitation sent to. We do not tie this email address to the user’s EDH account in any way, it is only used to deliver the invitation.

full_name : optional string
The full name of the person you want to invite to create a supporter page.

charity_id : optional string
The id of the charity that you want set for this supporter page. If no charity is supplied the user will be prompted to select a charity. Defaults to none.

target : optional decimal
The amount of money this page is aiming to raise. Defaults to a predetermined value.

Example

{
  "email": "api@everydayhero.com",
  "full_name": "everydayhero Support",
  "charity_id": "au-1",
  "target": 705.5
}

Response

{
  "join_team_invitation": {
    "id": 1,
    "email": "api@everydayhero.com",
    "accepted_at": null,
    "cancelled_at": null,
    "team_page_id": 1,
    "token": "xxxxxxxxx"
  }
}