Skip to content

invite.md

Latest commit

 

History

History
32 lines (20 loc) · 705 Bytes

invite.md

File metadata and controls

32 lines (20 loc) · 705 Bytes

Users

Invite a user to go on a walk

POST /users/invite

Description

Sends an invite to users given their IDs and sends a push notification to their iOS device (if available).

Authorization

  • A JWT for a registered user must be supplied in the Authorization field of the request header.
  • The token must be supplied in the format JWT 'token'

Parameters

  • users: [ObjectID] (required)
  • date: String (required)

Success response

  • Code: 200 OK
  • Content: A success flag and the Invite object

Errors

  • 400 Bad Request – userID not of type ObjectID
  • 401 Unauthorized – no/invalid JWT provided
  • 404 Not Found – user does not exist
⚡