Event Rsvps

Create an event rsvp

Changed on

Creates an event RSVP. Event RSVPs must contain enough signup data to find an existing signup in the nation, or create a new one. This means callers must provide a first name, last name, and email as part of the Event RSVP payload, which will be matched to an existing signup or will create a new signup with that data. Alternatively, callers may sidepost a signup resource as part of the payload. See sideposting documentation for details.

post/api/v2/event_rsvps

Request

  • Base URL
    https://yournation.nationbuilder.com
  • Auth
    HTTP bearer

Request body

Example request

{
  "data": {
    "type": "event_rsvps",
    "attributes": {
      "amount_in_cents": 350,
      "email": "lucille.ball@example.com",
      "event_id": "1",
      "first_name": "Lucille",
      "guests_count": 19,
      "last_name": "Ball",
      "page_id": "1",
      "tickets_count": 45,
      "billing_address_attributes": {
        "address1": "20 W 34th St.",
        "address2": "Suite 100",
        "address3": null,
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "county": "New York County",
        "country_code": "US",
        "lat": "40.7484",
        "lng": "73.9857",
        "fips": "04",
        "submitted_address": "20 W 34th St. Suite 100, New York, NY 10001",
        "distance": 0,
        "import_id": "2",
        "work_phone": "5555555555",
        "phone_number": "5555555555",
        "phone_country_code": "1",
        "work_phone_number": "5555555555"
      },
      "home_address_attributes": {
        "address1": "20 W 34th St.",
        "address2": "Suite 100",
        "address3": null,
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "county": "New York County",
        "country_code": "US",
        "lat": "40.7484",
        "lng": "73.9857",
        "fips": "04",
        "submitted_address": "20 W 34th St. Suite 100, New York, NY 10001",
        "distance": 0,
        "import_id": "2",
        "work_phone": "5555555555",
        "phone_number": "5555555555",
        "phone_country_code": "1",
        "work_phone_number": "5555555555"
      },
      "mailing_address_attributes": {
        "address1": "20 W 34th St.",
        "address2": "Suite 100",
        "address3": null,
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "county": "New York County",
        "country_code": "US",
        "lat": "40.7484",
        "lng": "73.9857",
        "fips": "04",
        "submitted_address": "20 W 34th St. Suite 100, New York, NY 10001",
        "distance": 0,
        "import_id": "2",
        "work_phone": "5555555555",
        "phone_number": "5555555555",
        "phone_country_code": "1",
        "work_phone_number": "5555555555"
      },
      "phone_number": "5555555555",
      "registered_address_attributes": {
        "address1": "20 W 34th St.",
        "address2": "Suite 100",
        "address3": null,
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "county": "New York County",
        "country_code": "US",
        "lat": "40.7484",
        "lng": "73.9857",
        "fips": "04",
        "submitted_address": "20 W 34th St. Suite 100, New York, NY 10001",
        "distance": 0,
        "import_id": "2",
        "work_phone": "5555555555",
        "phone_number": "5555555555",
        "phone_country_code": "1",
        "work_phone_number": "5555555555"
      },
      "user_submitted_address_attributes": {
        "address1": "20 W 34th St.",
        "address2": "Suite 100",
        "address3": null,
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "county": "New York County",
        "country_code": "US",
        "lat": "40.7484",
        "lng": "73.9857",
        "fips": "04",
        "submitted_address": "20 W 34th St. Suite 100, New York, NY 10001",
        "distance": 0,
        "import_id": "2",
        "work_phone": "5555555555",
        "phone_number": "5555555555",
        "phone_country_code": "1",
        "work_phone_number": "5555555555"
      },
      "work_address_attributes": {
        "address1": "20 W 34th St.",
        "address2": "Suite 100",
        "address3": null,
        "city": "New York",
        "state": "NY",
        "zip": "10001",
        "county": "New York County",
        "country_code": "US",
        "lat": "40.7484",
        "lng": "73.9857",
        "fips": "04",
        "submitted_address": "20 W 34th St. Suite 100, New York, NY 10001",
        "distance": 0,
        "import_id": "2",
        "work_phone": "5555555555",
        "phone_number": "5555555555",
        "phone_country_code": "1",
        "work_phone_number": "5555555555"
      }
    }
  }
}

Response

The newly created event rsvp.

metaobject

Non-standard information about the document. Empty unless the endpoint has metadata to convey.

Example response

{
  "data": {
    "id": "1",
    "type": "event_rsvps",
    "attributes": {
      "amount_in_cents": 350,
      "email": "lucille.ball@example.com",
      "event_id": "1",
      "first_name": "Lucille",
      "guests_count": 19,
      "last_name": "Ball",
      "page_id": "1",
      "tickets_count": 45,
      "created_at": "2019-10-26T10:00:00-04:00",
      "updated_at": "2019-10-26T10:00:00-04:00"
    }
  },
  "included": [
    {
      "id": "1"
    }
  ]
}

Changes

    • breaking

      added subschema #2 to the request body allOf list

    • breaking

      the request's body type changed from object to no type

    • breaking

      the response's body type changed from object to no type for status

    • breaking

      removed the required property from the response with the status

    • warning

      removed the request property

    • info

      added the media type application/vnd.api+json to the request body

    • info

      added subschema #2 to the response body allOf list for the response status

    • info

      media type application/json was changed to a more specific media type application/vnd.api+json for the response status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status