Create a Project

POST

https://api.vomo.org/v1/projects

POST

/v1/projects

curl -X POST https://api.vomo.org/v1/projects \
     -H "Authorization: Bearer <token>" \
     -H "Content-Type: application/json" \
     -d '{
  "name": "Community Gathering",
  "description": "Inviting & meeting new neighbors of the community. Serving meals, setup game stations, face paintings for kids...etc.",
  "allow_guests": 1,
  "age_limit": 13,
  "volunteer_question": "What is your t-shirt size?",
  "dates": [
    {}
  ]
}'

200Projects_createProject_example

{
  "data": {
    "type": "project",
    "id": "1234",
    "project_name": "Volunteer Project",
    "description": "A project description.",
    "url": "https://app.vomo.org/opportunity/1234",
    "organization": "VOMO",
    "organization_slug": "vomoslug",
    "author_id": 1234,
    "address": {
      "lat": 33.214561,
      "lng": -96.614456,
      "route": "Elm Street",
      "country": "United States",
      "locality": "McKinney",
      "timezone": "America/Chicago",
      "postal_code": "75069",
      "route_short": "Elm St",
      "country_short": "US",
      "street_number": "610",
      "locality_short": "McKinney",
      "formatted_address": "610 Elm St Suite 800, McKinney, TX 75069, USA",
      "postal_code_short": "75069",
      "street_number_short": "610",
      "administrative_area_level_1": "Texas",
      "administrative_area_level_1_short": "TX"
    },
    "anytime": 0,
    "created_at": "2020-01-01T12:00:00+00:00",
    "updated_at": "2020-01-01T12:00:00+00:00",
    "published_at": "2020-01-01T12:00:00+00:00",
    "draft": false,
    "campaigns": [
      {
        "type": "campaign",
        "id": "1",
        "campaign_name": "Together",
        "description": "Example description.",
        "url": "http://app.vomo.org/initiative/together",
        "organization": "VOMO",
        "organization_slug": "vomo",
        "author_id": 1,
        "logo_url": "https://s3.amazonaws.com/awakenmycity/j2/7Z/r4-s.jpg",
        "created_at": "2016-03-07T07:49:41+00:00",
        "updated_at": "2018-08-02T08:10:48+00:00"
      },
      {
        "type": "campaign",
        "campaign_id": "2",
        "campaign_name": "City Serve DC",
        "description": "",
        "url": "http://app.vomo.org/initiative/cityservedc",
        "organization": "VOMO",
        "organization_slug": "vomo",
        "author_id": 1,
        "logo_url": "https://s3.amazonaws.com/awakenmycity/j2/7Z/r4-s.jpg",
        "created_at": "2016-03-07T07:49:41+00:00",
        "updated_at": "2018-08-02T08:10:48+00:00"
      }
    ],
    "next_date": {
      "type": "project_date",
      "id": 5678,
      "starts_at": "2020-01-01T12:00:00+00:00",
      "ends_at": "2020-01-01T12:00:00+00:00",
      "participant_count": 20
    },
    "all_dates": [
      {
        "type": "project_date",
        "id": 5678,
        "starts_at": "2020-01-01T12:00:00+00:00",
        "ends_at": "2020-01-01T12:00:00+00:00",
        "participant_count": 20
      }
    ],
    "images": [
      "https://vomo-cdn.com/media/2019/01/01-sulmLi2Z-l.jpg",
      "https://vomo-cdn.com/media/2019/01/02-lkjfdL23-l.jpg"
    ]
  }
}

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

Project to create

namestringRequired

The name of the project

descriptionstringRequired

A description for the project

allow_guestsbooleanRequired

Whether to allow volunteers to bring guests

age_limitintegerRequired0-99

The minimum age a volunteer must be

volunteer_questionstringRequired

Ask your volunteers to provide additional information about themselves as they register. This field will be required to join the Serving Date.

dateslist of objectsRequired

Create Project

detailsstringOptional

Emphasize important details such as shoes to wear or items to bring. This information goes in the signup confirmation email, and is a great place to detail next steps in a Project

participant_approval_requiredbooleanOptional

Volunteers must be approved by the organizer before their spot is reserved.

background_check_requiredbooleanOptional

Volunteers must have a background check before signing up for your Project.

show_volunteer_counterbooleanOptional

Display number of participants. Note that this will only show on the project page if it is an Anytime project

volunteer_counter_thresholdintegerOptional0-99

The minimum number of volunteers signed up before the counter is shown. Note that this will only show on the project page if it is an Anytime project

draftbooleanOptional

When a project is in draft, it will not be viewable by anyone.

privacyenumOptional

Public is accessible by all VOMO users. Private is accessible only by the members of your Organization (those people in your People list).

Allowed values:

organization_idintegerOptional

The Organization ID to post the project to. Note, you must be part of the organization to post a project to it.

imageslist of objectsOptional

Create Project

point_personlist of objectsOptional

Identify a person to contact or meet on the day of the Project. This contact info goes in the signup confirmation email, but this person does not receive notifications.

categorieslist of objectsOptional

Create Project

campaignslist of objectsOptional

Create Project

attachment_fileslist of objectsOptional

Create Project

ownerslist of objectsOptional

Create Project

linkslist of objectsOptional

Create Project

addresslist of objectsOptional

The address where the project will take place. The format used is the standard Google address API.

project_typeenumOptional

Note: this cannot be changed after a project has been created! If the project has specific dates and times which volunteers are needed, it is dated. If there are no specific dates or times, it is an anytime.

Allowed values:

Response

successful operation