Team admin preferences

You can use the /v2/teams/:team_id/admin-preferences endpoints to manage the administrative preferences of the team.

This API is an extension of the Team API, that's why all url are prefixed with /teams/:team_id/. You can refer to the Teams API reference to have more informations about teams creation.

ENDPOINTS

GET /v2/teams/:team_id/admin-preferences

POST /v2/teams/:team_id/admin-preferences

PUT /v2/teams/:team_id/admin-preferences

The Admin preferences object

Attributes

• Belongs_to ObjectId

  The id of Team connected with this Admin preferences.

• Prefs Object

  The object, which contains the particular settings and preferences.

• email Object

  The email object contains particular email settings for the team

+ Show child attributes

• email. attending boolean

  This setting allows to get mails about visitors attending events of the team.

• email. declined boolean

  This setting allows to get mails about visitors declined events of the team.

• email. event_cancelled boolean

  This setting allows to get mails about events cancelled by others.

• email. event_cancelled_admin boolean

  This setting allows to get mails about events created and cancelled by your team.

• email. event_confirmed boolean

  This setting allows to get mails about events confirmed by others.

• email. event_confirmed_admin boolean

  This setting allows to get mails about events created and confirmed by your team.

• email. new_event boolean

  This setting allows to get mails about new events created by others.

• email. new_event_admin boolean

  This setting allows to get mails about new events created by your team.

• email. new_message boolean

  This setting allows to get messages of others about events you participate in or created.

• email. new_suggestion boolean

  This setting allows to get suggestions of others about your events.

• email. new_suggestion_own boolean

  This setting allows to get suggestions made by you.

• email. vote_update boolean

  This setting allows to get mails of people votes about your events.

• email. vote_confirmation boolean

  This setting allows to get confirmations of your votes.

• email. vyteme_created_admin boolean

  This setting allows to get notifications when the event is created from your Vyteme page.

THE ADMIN PREFERENCES OBJECT

{
  "prefs": {
    "email": {
      "attending": true,
      "declined": true,
      "event_cancelled": true,
      "event_cancelled_admin": true,
      "event_confirmed": true,
      "event_confirmed_admin": false,
      "new_event": false,
      "new_event_admin": false,
      "new_message": false,
      "new_suggestion": false,
      "new_suggestion_own": false,
      "vote_update": false,
      "vote_confirmation": false,
      "vyteme_created_admin": false
    }
  },
  "_id": "5fbd38e7198731eeaf57e4cb",
  "belongs_to": "5fbd38e7a6bb1d001c11863a",
  "updatedAt": "2020-11-24T16:46:31.666Z",
  "createdAt": "2020-11-24T16:46:31.666Z",
  "__v": 0
  }

Retrieve the admin preferences for the team

ENDPOINT Authorization apiKey

GET /v2/teams/:team_id/admin-preferences HTTP/1.1

Path parameters

• team_id string

  The _idof the team.

Query parameters

No parameters.

Returns

The admin-preferences of the particular team.

CODE SAMPLE

curl \
--request GET 'https://api.vyte.in/v2/teams/5fbd38e7a6bb1d001c11863a/admin-preference' \
--header 'Authorization: vkjvi2bvfo54ssbybmcts0x42z1sbzm6t0mot8trh8i03reno0' \

RESPONSE SAMPLE

{
  "prefs": {
    "email": {
      "attending": true,
      "declined": true,
      "event_cancelled": true,
      "event_cancelled_admin": true,
      "event_confirmed": true,
      "event_confirmed_admin": false,
      "new_event": false,
      "new_event_admin": false,
      "new_message": false,
      "new_suggestion": false,
      "new_suggestion_own": false,
      "vote_update": false,
      "vote_confirmation": false,
      "vyteme_created_admin": false
    }
  },
  "_id": "5fbd38e7198731eeaf57e4cb",
  "belongs_to": "5fbd38e7a6bb1d001c11863a",
  "updatedAt": "2020-11-24T16:46:31.666Z",
  "createdAt": "2020-11-24T16:46:31.666Z",
  "__v": 0
  }

Create an admin preferences

ENDPOINT Authorization apiKey

POST /v2/teams/5fbd38e7a6bb1d001c11863a/admin-preferences HTTP/1.1

Path parameters

• team_id string

  The _idof the team.

Query parameters

No parameters.

Body parameters

• attending boolean

  This setting allows to get mails about visitors attending events of the team.

• declined boolean

  This setting allows to get mails about visitors declined events of the team.

• event_cancelled boolean

  This setting allows to get mails about events cancelled by others.

• event_cancelled_admin boolean

  This setting allows to get mails about events created and cancelled by your team.

• event_confirmed boolean

  This setting allows to get mails about events confirmed by others.

• event_confirmed_admin boolean

  This setting allows to get mails about events created and confirmed by your team.

• new_event boolean

  This setting allows to get mails about new events created by others.

• new_event_admin boolean

  This setting allows to get mails about new events created by your team.

• new_message boolean

  This setting allows to get messages of others about events you participate in or created.

• new_suggestion boolean

  This setting allows to get suggestions of others about your events.

• new_suggestion_own boolean

  This setting allows to get suggestions made by you.

• vote_update boolean

  This setting allows to get mails of people votes about your events.

• vote_confirmation boolean

  This setting allows to get confirmations of your votes.

• vyteme_created_admin boolean

  This setting allows to get notifications when the event is created from your Vyteme page.

Returns

The created Admin preferences object if no error occurred.

CODE SAMPLE

curl \
--request POST 'https://api.vyte.in/v2/teams/5fbe426b28fd0e0016ca3ff5/admin-preferences' \
--header 'Authorization: vkjvi2bvfo54ssbybmcts0x42z1sbzm6t0mot8trh8i03reno0' \
--header 'Content-Type: application/json' \
--data-raw '
    {
      "prefs": {
        "email": {
          "attending": true,
          "declined": true,
          "event_cancelled": true,
          "event_cancelled_admin": true,
          "event_confirmed": true,
          "new_event": true
        }
    }
}'

RESPONSE SAMPLE

{
  "prefs": {
    "email": {
      "attending": true,
      "declined": true,
      "event_cancelled": true,
      "event_cancelled_admin": true,
      "event_confirmed": true,
      "event_confirmed_admin": false,
      "new_event": true,
      "new_event_admin": false,
      "new_message": false,
      "new_suggestion": false,
      "new_suggestion_own": false,
      "vote_update": false,
      "vote_confirmation": false,
      "vyteme_created_admin": false
    }
  },
"_id": "5fbd38e7198731eeaf57e4cb",
"belongs_to": "5fbd38e7a6bb1d001c11863a",
"updatedAt": "2020-11-24T16:46:31.666Z",
"createdAt": "2020-11-24T16:46:31.666Z",
"__v": 0
}

Update the admin preferences of the team

ENDPOINT Authorization apiKey

PUT /v2//v2/teams/5fbe426b28fd0e0016ca3ff5/admin-preferences HTTP/1.1

Path parameters

• team_id string

  The _idof the team.

Query parameters

No parameters.

Body parameters

• attending boolean

  This setting allows to get mails about visitors attending events of the team.

• declined boolean

  This setting allows to get mails about visitors declined events of the team.

• event_cancelled boolean

  This setting allows to get mails about events cancelled by others.

• event_cancelled_admin boolean

  This setting allows to get mails about events created and cancelled by your team.

• event_confirmed boolean

  This setting allows to get mails about events confirmed by others.

• event_confirmed_admin boolean

  This setting allows to get mails about events created and confirmed by your team.

• new_event boolean

  This setting allows to get mails about new events created by others.

• new_event_admin boolean

  This setting allows to get mails about new events created by your team.

• new_message boolean

  This setting allows to get messages of others about events you participate in or created.

• new_suggestion boolean

  This setting allows to get suggestions of others about your events.

• new_suggestion_own boolean

  This setting allows to get suggestions made by you.

• vote_update boolean

  This setting allows to get mails of people votes about your events.

• vote_confirmation boolean

  This setting allows to get confirmations of your votes.

• vyteme_created_admin boolean

  This setting allows to get notifications when the event is created from your Vyteme page.

Returns

The updated Admin preferences object if no error occurred.

CODE SAMPLE

curl --request PUT 'https://api.vyte.in/v2/teams/5fbe426b28fd0e0016ca3ff5/admin-preferences' \
--header 'Authorization: vkjvi2bvfo54ssbybmcts0x42z1sbzm6t0mot8trh8i03reno0' \
--header 'Content-Type: application/json' \
--data-raw '
 {
      "prefs": {
        "email": {
          "attending": true,
          "declined": true,
          "event_cancelled": true,
          "event_cancelled_admin": true,
          "event_confirmed": true,
          "new_event": false
          "vite_confirmation": true
        }
    }
}
'

RESPONSE SAMPLE

{
  "prefs": {
    "email": {
      "attending": true,
      "declined": true,
      "event_cancelled": true,
      "event_cancelled_admin": true,
      "event_confirmed": true,
      "event_confirmed_admin": false,
      "new_event": false,
      "new_event_admin": false,
      "new_message": false,
      "new_suggestion": false,
      "new_suggestion_own": false,
      "vote_update": false,
      "vote_confirmation": true,
      "vyteme_created_admin": false
    }
  },
"_id": "5fbd38e7198731eeaf57e4cb",
"belongs_to": "5fbd38e7a6bb1d001c11863a",
"updatedAt": "2020-11-24T16:46:31.666Z",
"createdAt": "2020-11-24T16:46:31.666Z",
"__v": 0
}