Supported Formats

json

Errors

Code Description
401 Unauthorized
403 Forbidden
404 Project Not Found

Params

Param name Description
id
required

Project ID

Validations:

  • Must be a String

fields
optional

comma separated fields wanted in payload

Validations:

  • Must be a String

project
optional

Project parameter container

Validations:

  • Must be a Hash

project[name]
optional

Project name

Validations:

  • Must be a String

project[account_id]
optional

Account ID

Validations:

  • Must be a String

project[default_template_id]
optional

Default template ID

Validations:

  • Must be a String

project[status]
optional

running, paused, archived

Validations:

  • Must be a String

project[public]
optional

not private

Validations:

  • Must be a Boolean

project[max_in_progress]
optional

Maximum number of tasks allowed to be in progress

Validations:

  • Must be a Integer

project[plagiarism_percentage]
optional

Plagiarism Percentage

Validations:

  • Must be a Integer

project[spellchecker]
optional

Spellchecker name

Validations:

  • Must be a String

project[rule_check_for]
optional

Rule check for :writer, :editor, :client, :manager

Validations:

  • Must be an array of any type