Find or create invitation via API

Find or create invitation via API




Find or create invitation via API.



Introduction

Welcome, this is a tutorial to find or create invitations via API.



Parameters


URL
Require Authentication
Method HTTP
/api/v1/findOrCreateInvite
yes
POST


 Cargas Útil

Argumento
Example
Required
Description
rid

'csFYrDeixJG7PnrAh'

yes

The id of the room for which the invitation is being created.

days
0
yes

The number of days the invitation will be valid. Send 0 for unlimited

maxUses
20
yes

The number of times the invitation can be used. Submit 0 for unlimited.




Call Example


  1. curl -H "X-Auth-Token: 9HqLlyZOugoStsXCUfD_0YdwnNnunAJF8V47U3QHXSq" \
     -H "X-User-Id: aobEdbYhXfu5hkeqG" \
     -H "Content-type: application / json" \
     https://<myoffice>.myhive.global/api/v1/findOrCreateInvite \
     -d '{"rid": "csFYrDeixJG7PnrAh", "days": 10, "maxUses": 0}'

Result:
  1. {

        "_id" :
    "kDKQ3H" ,

        "days" :
    10 ,

        "maxUses" :
    0 ,

        "rid" :
    "csFYrDeixJG7PnrAh" ,

        "userId" :
    "sNiDqHit5nGAGFg8X" ,

        "createdAt" :
    "2017-01-06T13: 23: 46.018Z" ,

        "expire" :
    "2017-01-16T13: 23: 46.018Z" ,

        "_updatedAt" :
    "2017-01-06T13: 23: 46.018Z" ,

        "use" :
    0 ,

        "result" :true
    }
Observation:

In case of doubts or suggestions, please contact our support via e-mail: suportebr@myhive.global









    • Related Articles

    • Creating user via API.

      Creating user via API. Introduction Welcome, this is a tutorial to login via API Parameters URL Require Authentication Method HTTP /api/v1/users.create yes POST Variables Note: To save customFields, you must first define customFields in the admin ...
    • Disable users via API.

      Disable users via API. Introduction Welcome, this is a tutorial to disable user via API. Note: Disable inactive users. Permission required:    edit-other-user-active-status. Parameters URL Require Authentication Method HTTP ...
    • Set status via API

      Set status via API. Introduction Welcome, this is a tutorial to help set status via API. Defines a user status when status message and status are provided. Arguments: URL Require Authentication Method HTTP /api/v1/users.setAvatar yes POST  Payloads ...
    • Translate message via API

      Translate message via API. Introduction Welcome, this is a tutorial to translate a message via API. Translate the message provided. Arguments URL Require Authentication Método HTTP /api/v1/autotranslate.translateMessage yes POST  Payloads Argument ...
    • Paging via API

      Paging via API. Introduction Welcome, this is a tutorial to help understand how to count, offset, sort via API. As of version, some of the endpoints support query parameters, and . However, the defaults are different by server due to configuration ...