Boarding Templates

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 template belongs to	Cannot be set
discarded_at	Null or timestamp of removal	Cannot be set
name	Name of the on- or offboarding template	Must be set
message	The default message that is used for new onboardings (not used on offboardings)	Can be set on create & update endpoint, is optional
boarding_template_stages
boarding_stage_id	ID of the related boarding stage	Must be set
tasks	List of tasks in this stage of the template	Must be an array of objects, where each object represents a task. Detailed information on task object, see table below

Task-Attributes	Description	Specifics
name	Name of a task	Mandatory, Value of type string.
description	Description of a task	Optional, Value of type string.

The following relationships can be included in requests:

Relationship	Type
boarding_template_stages	has many

Meta data: Permissions

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

Create

Example request:

{
  "data": {
    "type": "boarding_template",
    "attributes": {
      "name": "1st Template"
    }
  }
}

Example response:

{
  "data": {
    "id": "95579c3b-20ed-43b8-ab79-d60d05690be5",
    "type": "boarding_template",
    "attributes": {
      ...
    }
  }
}

This endpoint creates an on- or offboarding template.

HTTP Request

POST /api/v1/boarding_templates

Update

Example request:

{
  "data": {
    "type": "boarding_template",
    "attributes": {
      "name": "Updated Boarding Template"
    }
  }
}

Example response:

{
  "data": {
    "id": "37947040-e097-475e-8170-13ed76fc6281",
    "type": "boarding_template",
    "attributes": {
      ...
    }
  }
}

This endpoint updates an on- or offboarding template.

HTTP Request

PUT /api/v1/boarding_templates/:boarding_template_id

URL Parameters

Parameter	Description
boarding_template_id	ID of the on- or offboarding template to be updated

Show

Example response:

{
  "data": {
    "id": "ce7889a1-5bd3-4b9b-9a31-092d1b384f47",
    "type": "boarding_template",
    "attributes": {
      ...
    }
  }
}

This endpoint returns an on- or offboarding template.

HTTP Request

GET /api/v1/boarding_templates/:boarding_template_id

URL Parameters

Parameter	Description
boarding_template_id	The ID of the on- or offboarding_template to return

List

Example response:

{
  "data": [
    {
      "id": "14833508-e59c-4177-86db-dda7575ff61e",
      "type": "boarding_template",
      "attributes": {
        ...
      }
    },
    {
      ...
    }
  ]
}

This endpoint returns all boarding templates.

HTTP Request

GET /api/v1/boarding_templates

Delete

Example response:

{
  "data": {
    "id": "ce7889a1-5bd3-4b9b-9a31-092d1b384f47",
    "type": "boarding_template",
    "attributes": {
      ...
    }
  }
}

This endpoint deletes an on- or offboarding template.

HTTP Request

DELETE /api/v1/boarding_template/:boarding_template_id

URL Parameters

Parameter	Description
boarding_template_id	The ID of the on- or offboarding_template to delete