Application Stages

List of valid attributes:

Attribute	Description	Specifics
account_id	ID of the account that the application stage belongs to	Cannot be set
discarded_at	Null or timestamp of removal	Cannot be set
name	Name of the application stage	Must be set
position	Position of the application stage	Must be set, must be integer >= 0

Meta data: Permissions

Group	Description
actions	Contains permissions to edit or delete an application stage

Create

Example request:

{
  "data": {
    "type": "application_stage",
    "attributes": {
      "name": "Application Stage"
    }
  }
}

Example response:

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

This endpoint creates an application stage.

HTTP Request

POST /api/v1/application_stages

Update

Example request:

{
  "data": {
    "type": "application_stage",
    "attributes": {
      "name": "Updated Application Stage"
    }
  }
}

Example response:

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

This endpoint updates an application stage.

HTTP Request

PUT /api/v1/application_stages/:application_stage_id

URL Parameters

Parameter	Description
application_stage_id	ID of the application stage to be updated

Show

Example response:

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

This endpoint returns an application stage.

HTTP Request

GET /api/v1/application_stages/:application_stage_id

URL Parameters

Parameter	Description
application_stage_id	ID of the application stage to return

List

Example response:

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

This endpoint returns all application stages.

HTTP Request

GET /api/v1/application_stages

Delete

Example response:

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

This endpoint deletes an application stage.

HTTP Request

DELETE /api/v1/application_stages/:application_stage_id

URL Parameters

Parameter	Description
application_stage_id	ID of the application stage to delete