Contract Templates

List of valid attributes:

Attribute	Description	Specifics
discarded_at	Null or timestamp of removal	Cannot be set
name	Name of the template	Must be set
wording	Content of the contract	Must be set

Meta data: Permissions

Group	Description
actions	Contains permissions to edit or delete a contract template

Create

Example request:

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

Example response:

{
  "data": {
    "id": "1e9f83a6-51a7-445a-bd6e-5e0350f24c93",
    "type": "contract_template",
    "attributes": {
      ...
    }
  }
}

This endpoint creates a new contract template.

HTTP Request

POST /api/v1/contract_templates

Update

Example request:

{
  "data": {
    "type": "contract_template",
    "attributes": {
      "name": "Updated Contract Template"
    }
  }
}

Example response:

{
  "data": {
    "id": "7f82a5b1-5890-4fde-b2f0-fb7469ebc8d1",
    "type": "contract_template",
    "attributes": {
      ...
    }
  }
}

This endpoint updates an contract template.

HTTP Request

PUT /api/v1/contract_templates/:contract_template_id

URL Parameters

Parameter	Description
contract_template_id	ID of the contract template to be updated

Show

Example response:

{
  "data": {
    "id": "11ed62a0-d0fb-4603-a1aa-60a8e2a4a12a",
    "type": "contract_template",
    "attributes": {
      ...
    }
  }
}

This endpoint returns an contract template.

HTTP Request

GET /api/v1/contract_templates/:contract_template_id

URL Parameters

Parameter	Description
contract_template_id	ID of the contract template to return

List

Example response:

{
  "data": [
    {
      "id": "1e9f83a6-51a7-445a-bd6e-5e0350f24c93",
      "type": "contract_template",
      "attributes": {
        ...
      }
    },
    {
      ...
    }
  ]
}

This endpoint returns contract templates of an account.

HTTP Request

GET /api/v1/contract_templates

Delete

Example response

{
  "data": {
    "id": "f8fc2bf2-456e-46fe-af18-bb895d585f94",
    "type": "contract_template",
    "attributes": {
      ...
    }
  }
}

This endpoint deletes an contract template.

HTTP Request

DELETE /api/v1/contract_templates/:contract_template_id

URL Parameters

Parameter	Description
contract_template_id	ID of the contract template to delete