Skip to content
Robert Brodie edited this page May 28, 2024 · 3 revisions

See API documentation for available fields.

Create a project

project = client.Project.build
project.save({ key: 'SAMPLEPROJECT',
               name: 'Sample Project',
               projectTypeKey: 'business',
               leadAccountId: '5e17314b0af0d70e911d3917' })

Find a specific project by key

project = client.Project.find('SAMPLEPROJECT')
puts project

Get all projects

projects = client.Project.all

projects.each do |project|
  puts "Project -> key: #{project.key}, name: #{project.name}"
end

Move a project to the trash

project = client.Project.find('SAMPLEPROJECT')
project.delete

Update a project

project = client.Project.find('SAMPLEPROJECT')
project.save({ name: 'Sample Project (Updated)' })