Boarding Stages

List of valid attributes:

Attribute	Description	Specifics
boarding_type	’onboarding’ or ‘offboarding’	Must be set on creation, cannot be changed later
account_id	ID of the account the boarding stage belongs to	Cannot be set
discarded_at	Null or timestamp of removal	Cannot be set
name	Name of the on- or offboarding stage	Must be set
position	Position of the on- or offboarding stage	Must be set, must be integer >= 0

Meta data: Permissions

Group	Description
actions	Contains permissions to edit or delete an on- or offboarding stage

Create

Example request:

{
  "data": {
    "type": "boarding_stage",
    "attributes": {
      "name": "Boarding Stage"
    }
  }
}

Example response:

{
  "data": {
    "id": "459e0b1e-caa0-4960-be61-dad0dbcd969e",
    "type": "boarding_stage",
    "attributes": {
      ...
    }
  }
}

This endpoint creates an on- or offboarding stage.

HTTP Request

POST /api/v1/boarding_stages

Update

Example request:

{
  "data": {
    "type": "boarding_stage",
    "attributes": {
      "name": "Updated Boarding Stage"
    }
  }
}

Example response:

{
  "data": {
    "id": "3f4e90bf-ec8c-439b-83f5-89e753213859",
    "type": "boarding_stage",
    "attributes": {
      ...
    }
  }
}

This endpoint updates an on- or offboarding stage.

HTTP Request

PUT /api/v1/boarding_stages/:boarding_stage_id

URL Parameters

Parameter	Description
onbarding_stage_id	ID of the on- or offboarding stage to be updated

Show

Example response:

{
  "data": {
    "id": "3aab0a84-8ed3-4ddf-8572-f1799bb60e0a",
    "type": "boarding_stage",
    "attributes": {
      ...
    }
  }
}

This endpoint returns an on- or offboarding stage.

HTTP Request

GET /api/v1/boarding_stages/:boarding_stage_id

URL Parameters

Parameter	Description
boarding_stage_id	The ID of the on- or offboarding_stage to return

List

Example response:

{
  "data": [
    {
      "id": "bdfdc766-f48b-470d-966b-8b6f1873da7f",
      "type": "boarding_stage",
      "attributes": {
        ...
      }
    },
    {
      ...
    }
  ]
}

This endpoint returns all boarding stages.

HTTP Request

GET /api/v1/boarding_stages

Delete

Example response:

{
  "data": {
    "id": "2ce7ed10-90d4-45da-b284-67966f488e2d",
    "type": "boarding_stage",
    "attributes": {
      ...
    }
  }
}

This endpoint deletes an on- or offboarding stage.

HTTP Request

DELETE /api/v1/boarding_stages/:boarding_stage_id

URL Parameters

Parameter	Description
boarding_stage_id	The ID of the on- or offboarding_stage to delete