POST /api/v2/collections/:collection_id/guests
Invite guest by email

Headers

Header name	Description
Content-Type required	application/json
X-API-KEY required	YOUR_API_KEY

Params

Param name	Description
email required	Email Validations: Must be a String

Examples

// Successful request
POST /api/v2/collections/kSC6NWYt-nEfC1yEbIW0/guests
{
  "email": "example-email@example.com"
}
200
{
  "users": [
    {
      "id": 28,
      "first_name": null,
      "last_name": null,
      "email": "admin-user-28@example.com",
      "user_role": {
        "name": "admin"
      }
    },
    {
      "id": 29,
      "first_name": null,
      "last_name": null,
      "email": "example-email@example.com",
      "user_role": {
        "name": "guest"
      }
    }
  ]
}

// Successful request
POST /api/v2/collections/U9QovyOZeApaXzzuHw6R/guests
{
  "email": "admin-user-29@example.com"
}
400
{
  "error": "User already exists"
}

// If :collection_id is not found
POST /api/v2/collections/not-found-id/guests
{
  "email": "example-email@example.com"
}
404
{
  "error": "collection not found"
}

// Failed request
POST /api/v2/collections/not-found-id/guests
404
{
  "error": "collection not found"
}

// Successful request
POST /api/v2/collections/ubWcohbSFUdGEjv2vGe3/guests
{
  "email": "testiemail@tvtools.fi"
}
200
{
  "users": [
    {
      "id": 59,
      "first_name": null,
      "last_name": null,
      "email": "admin-user-58@example.com",
      "user_role": {
        "name": "admin"
      }
    },
    {
      "id": 60,
      "first_name": null,
      "last_name": null,
      "email": "testiemail@tvtools.fi",
      "user_role": {
        "name": "guest"
      }
    }
  ]
}

// User with given email does not already exist
POST /api/v2/collections/ksT2J4QGhvhsLkFVD0nB/guests
{
  "email": "testiemail@tvtools.fi"
}
200
{
  "users": [
    {
      "id": 61,
      "first_name": null,
      "last_name": null,
      "email": "admin-user-59@example.com",
      "user_role": {
        "name": "admin"
      }
    },
    {
      "id": 62,
      "first_name": null,
      "last_name": null,
      "email": "testiemail@tvtools.fi",
      "user_role": {
        "name": "guest"
      }
    }
  ]
}

Errors

Code	Description
401	Unauthorized
404	Not found
500	Internal Server Error
422	Missing parameters