api/pageplace.family-v1-family-post.rst

   1 ==============================================
   2 ``POST https://family.pageplace.de/v1/family``
   3 ==============================================
   4
   5 Add someone to a family.
   6
   7 To add a family member, an OAuth token with scope ``family`` needs to be
   8 obtained.
   9
  10
  11 Request
  12 =======
  13 Header
  14   See `family v1 header set`_.
  15
  16 Body
  17   JSON encoded object.
  18
  19   ``resellerId``
  20     Example: ``81``
  21   ``token``
  22     Example: ``eyJhbGciOiJSUzUxMiJ9.eyJpc3MiOiJ3...hGCE8Yc6g``
  23
  24
  25 Response
  26 ========
  27 HTTP status code ``200 OK``.
  28
  29 All family members are returned.
  30
  31 Family with 3 members
  32 ---------------------
  33 Example:
  34
  35 .. include:: pageplace.family-v1-family-post.response.json
  36    :code: