API Documentation
Invitations ¶
Invitations ¶
POST /api/v2/invitations
Requests
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": ""
}
}
}
Responses
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 invitationPOST/api/v2/invitations
URI Parameters
- id
number
(required) Example: 1invitation id
GET /api/v2/invitations/1
Requests
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
Responses
Headers
Content-Type: application/vnd.api+json; charset=utf-8
Body
{
"data": {
"id": "1BSSYBsQexdr23MFYZya",
"type": "invitations",
"attributes": {
"email": "user738@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
Responses
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 invitationGET/api/v2/invitations/{id}
URI Parameters
- id
number
(required) Example: 1invitation id
PATCH /api/v2/invitations/1
Requests
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"
}
}
}
Responses
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"
}
}
}
Responses
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 invitationPATCH/api/v2/invitations/{id}
URI Parameters
- id
number
(required) Example: 1invitation id
Generated by aglio on 23 Jan 2021