Difference between revisions of "Single-Use Links"

From SimplyMeet.me
 
(3 intermediate revisions by the same user not shown)
Line 1: Line 1:
 
Single-use links are used to create a meeting once which can't be used again. Once someone schedules a meeting with you, the link is no longer valid.
 
Single-use links are used to create a meeting once which can't be used again. Once someone schedules a meeting with you, the link is no longer valid.
 +
You can create such links one by one or in a batch (up to 56 at once).<br>
 +
'''Request for one link'''<br>
 +
<span style="background-color:#4dcb7b; color:white; padding:5px; border-radius:15px;">POST</span>'''Create a Single-Use Link'''
 +
<pre>https://secure.simplymeet.me/api/single-use-link</pre>
 +
Create new single-use link based on the existing meeting type.<br>
  
−
<span style="background-color:#4dcb7b; color:white; padding:5px; border-radius:15px;">POST</span>'''Create a Single-Use Link'''
 
−
<pre>https://app.simplymeet.me/api/single-use-link</pre>
 
−
Create new single-use link based on the existing meeting type.
 
−
'''Request'''
 
 
{| class="table" style="width:100%; border: 2px solid black;"
 
{| class="table" style="width:100%; border: 2px solid black;"
 
|-  
 
|-  
Line 22: Line 23:
 
| colspan="3" style="color:gray; border-bottom: 2px solid gray" |Body Parameters
 
| colspan="3" style="color:gray; border-bottom: 2px solid gray" |Body Parameters
 
|-  
 
|-  
−
| meeting_type_uuid<br><span style="font-size:10px; color:gray;">OPTIONAL</span>
+
| meeting_type_uuid<br><span style="font-size:10px; color:gray;">REQUIRED</span>
 +
| <code>string</code>
 +
| UUID of the existing Meeting Type.
 +
|}
 +
<br>
 +
'''Request for a set of links'''<br>
 +
<span style="background-color:#4dcb7b; color:white; padding:5px; border-radius:15px;">POST</span>'''Create a Single-Use Link List'''
 +
<pre>https://secure.simplymeet.me/api/single-use-link-list</pre>
 +
{| class="table" style="width:100%; border: 2px solid black;"
 +
|-
 +
| colspan="3" style="color:gray; border-bottom: 2px solid gray" |Headers
 +
|-
 +
| Content-Type<br><span style="font-size:10px; color:gray;">OPTIONAL</span>
 +
| <code>string</code>
 +
| application/json
 +
|-
 +
| X-API-KEY<br><span style="font-size:10px; color:red;">REQUIRED</span>
 +
| <code>string</code>
 +
| Your API key
 +
|}
 +
<br>
 +
{| class="table" style="width:100%; border: 2px solid black;"
 +
|-
 +
| colspan="3" style="color:gray; border-bottom: 2px solid gray" |Body Parameters
 +
|-
 +
| count<br><span style="font-size:10px; color:red;">REQUIRED</span>
 +
| <code>number</code>
 +
| number of links to be generated.
 +
|-
 +
| meeting_type_uuid<br><span style="font-size:10px; color:red;">REQUIRED</span>
 
| <code>string</code>
 
| <code>string</code>
 
| UUID of the existing Meeting Type.
 
| UUID of the existing Meeting Type.
 
|}
 
|}
 +
  
  
Line 44: Line 75:
 
{
 
{
 
   "code":"random-string",
 
   "code":"random-string",
−
   "url":"https://app.simplymeet.me/s/random-string"
+
   "url":"https://secure.simplymeet.me/s/random-string"
 
}
 
}
 
</pre>
 
</pre>
Line 70: Line 101:
 
'''Examples'''
 
'''Examples'''
 
<pre>
 
<pre>
−
curl --location --request POST 'https://app.simplymeet.me/api/single-use-link' \
+
curl --location --request POST 'https://secure.simplymeet.me/api/single-use-link' \
 
--header 'Content-Type: application/json' \
 
--header 'Content-Type: application/json' \
 
--header 'X-API-KEY: YOUR_API_KEY' \
 
--header 'X-API-KEY: YOUR_API_KEY' \

Latest revision as of 14:11, 5 April 2023

Single-use links are used to create a meeting once which can't be used again. Once someone schedules a meeting with you, the link is no longer valid. You can create such links one by one or in a batch (up to 56 at once).
Request for one link
POSTCreate a Single-Use Link 

https://secure.simplymeet.me/api/single-use-link

Create new single-use link based on the existing meeting type.

Headers
Content-Type
OPTIONAL 		string application/json
X-API-KEY
REQUIRED 		string Your API key


Body Parameters
meeting_type_uuid
REQUIRED 		string UUID of the existing Meeting Type.


Request for a set of links
POSTCreate a Single-Use Link List 

https://secure.simplymeet.me/api/single-use-link-list
Headers
Content-Type
OPTIONAL 		string application/json
X-API-KEY
REQUIRED 		string Your API key


Body Parameters
count
REQUIRED 		number number of links to be generated.
meeting_type_uuid
REQUIRED 		string UUID of the existing Meeting Type.


Response

200: OK
Single-Use Link successfully created. 

{
   "code":"random-string",
   "url":"https://secure.simplymeet.me/s/random-string"
}

422: Unprocessable Entity

{
   "message":"Invalid arguments",
   "errors":{
      "meetingTypeUuid":[
         "Meeting Type with uuid 7ab22519-0135-2941-0bd6-a3381d173110 was not found."
      ]
   }
}

Examples 

curl --location --request POST 'https://secure.simplymeet.me/api/single-use-link' \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: YOUR_API_KEY' \
--data-raw '    {
      "meeting_type_uuid": "7ab22519-0135-2941-0bd6-a3381d173110"
    }'
Retrieved from "https://help.simplymeet.me/index.php?title=Single-Use_Links&oldid=8233"