API Documentation

API Endpoint

Invitations

Invitations

POST /api/v2/invitations
Requestsreturns error

POST  /api/v2/invitations

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "invitations",
    "attributes": {
      "token": "",
      "email": ""
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not valid",
      "source": {
        "pointer": "data/attributes/token"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/token"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/email"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is not an email",
      "source": {
        "pointer": "data/attributes/email"
      }
    }
  ]
}

Creates a invitation
POST/api/v2/invitations

URI Parameters
HideShow
id
number (required) Example: 1

invitation id

GET /api/v2/invitations/1
Requestsreturns invitation_tokenreturns error

GET  /api/v2/invitations/1BSSYBsQexdr23MFYZya

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses200
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "data": {
    "id": "1BSSYBsQexdr23MFYZya",
    "type": "invitations",
    "attributes": {
      "email": "user855@email.com",
      "first_name": "test first name",
      "last_name": "test last name",
      "time_zone": null
    }
  },
  "meta": {
    "settings": {}
  }
}

GET  /api/v2/invitations/not_an_invitation_token

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Responses404
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "404",
      "code": "record_not_found",
      "title": "Record Not Found",
      "detail": "The requested record was not found",
      "source": {
        "pointer": null
      }
    }
  ]
}

Gets a invitation
GET/api/v2/invitations/{id}

URI Parameters
HideShow
id
number (required) Example: 1

invitation id

PATCH /api/v2/invitations/1
Requestsaccepts invitationreturns error

PATCH  /api/v2/invitations/1BSSYBsQexdr23MFYZya

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "invitations",
    "attributes": {
      "password": "abc123456",
      "newsletter_consent": "true"
    }
  }
}
Responses204
This response has no content.

PATCH  /api/v2/invitations/1BSSYBsQexdr23MFYZya

Headers
Accept: text/xml,application/xml,application/xhtml+xml,text/html;q=0.9,text/plain;q=0.8,image/png,*/*;q=0.5
Content-Type: application/vnd.api+json
Body
{
  "data": {
    "type": "invitations",
    "attributes": {
      "password": "",
      "newsletter_consent": "true"
    }
  }
}
Responses422
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
  "errors": [
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "can't be blank",
      "source": {
        "pointer": "data/attributes/password"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is invalid",
      "source": {
        "pointer": "data/attributes/password"
      }
    },
    {
      "status": "422",
      "code": "invalid_attribute",
      "title": "Invalid Attribute",
      "detail": "is too short (minimum is 8 characters)",
      "source": {
        "pointer": "data/attributes/password"
      }
    }
  ]
}

Update a invitation
PATCH/api/v2/invitations/{id}

URI Parameters
HideShow
id
number (required) Example: 1

invitation id

Generated by aglio on 15 Jun 2021