openapi: 3.1.2
info:
title: NationBuilder V2 Async Processes Event Rsvps API
version: '2.0'
description: 'The NationBuilder V2 API is a JSON:API-compliant API for managing NationBuilder
resources such as people, donations, events, and lists. It layers a few
conventions on top of the JSON:API standard, described below. For a broader
introduction, see the
[NationBuilder v2 API core concepts](https://support.nationbuilder.com/en/articles/9757369-nationbuilder-v2-api-core-concepts)
guide.
### Request and response format
Requests and responses follow the [JSON:API](https://jsonapi.org/) document
structure: single resources are returned under a top-level `data` member, and
collections are paginated arrays of resource objects with `links` for the
current, previous, and next pages. Related resources can be sideloaded into a
top-level `included` array with the `include` query parameter, and responses
can be trimmed to specific attributes with `fields[resource_type]` sparse
fieldsets (plus opt-in `extra_fields[resource_type]` attributes where noted).
Responses are served as `application/vnd.api+json`; request bodies may be
sent as `application/vnd.api+json` or `application/json`.
Filtering uses an operator syntax: `filter[attribute]=value` for
equality (comma-separated values act as OR), and
`filter[attribute][operator]=value` for other comparisons. String attributes
support `eq`, `not_eq`, `eql`, `not_eql`, `prefix`, `not_prefix`, `suffix`,
`not_suffix`, `match`, and `not_match`; numeric and date attributes support
`eq`, `not_eq`, `gt`, `gte`, `lt`, and `lte`. Note that JSON:API relationship
routes (`/resource/{id}/relationships/other`) are not provided; related
resources are reachable through the filtered index URLs given in each
resource''s `relationships` links.
### Errors
Error responses use a flat JSON body with a machine-readable `code` and a
human-readable `message`. Some errors carry additional detail members (for
example `validation_errors`). The exception is 422 validation failures,
which return a JSON:API `errors` array locating each invalid field via
`source.pointer`.
### Rate limiting
Requests are limited per access token (250 requests per 10-second window).
Every response includes `RateLimit-Limit`, `RateLimit-Remaining`, and
`RateLimit-Reset` headers; exceeding the limit returns a 429 with a
`Retry-After` header.
'
servers:
- url: https://{subdomain}.nationbuilder.com
variables:
subdomain:
default: yournation
description: Your NationBuilder nation slug
security:
- BearerAuth: []
tags:
- name: Event Rsvps
x-tag-expanded: false
description: This resource is for creating, reading, updating, and deleting Event RSVPs. When creating event RSVPs, the rsvp must be given signup data, either by passing a first name, last name, and email or phone number, or by sideposting a signup.
paths:
/api/v2/event_rsvps:
parameters:
- $ref: '#/components/parameters/event_rsvp_index_include'
- $ref: '#/components/parameters/event_rsvp_sparse_fields'
post:
summary: Create an event rsvp
tags:
- Event Rsvps
description: 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.
operationId: createEventRsvp
responses:
'201':
description: The newly created event rsvp.
headers:
RateLimit-Limit:
$ref: '#/components/headers/RateLimit-Limit'
RateLimit-Remaining:
$ref: '#/components/headers/RateLimit-Remaining'
RateLimit-Reset:
$ref: '#/components/headers/RateLimit-Reset'
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/event_rsvp_show_response'
'400':
$ref: '#/components/responses/bad_request'
'401':
$ref: '#/components/responses/unauthorized'
'422':
$ref: '#/components/responses/unprocessable'
'429':
$ref: '#/components/responses/rate_limited'
requestBody:
$ref: '#/components/requestBodies/event_rsvp_create_request_body'
get:
summary: List all event rsvps in a nation
tags:
- Event Rsvps
description: Lists all event RSVPs in a nation
operationId: listEventRsvps
parameters:
- $ref: '#/components/parameters/pagination_number'
- $ref: '#/components/parameters/pagination_size'
responses:
'200':
description: A page of matching event rsvps.
headers:
RateLimit-Limit:
$ref: '#/components/headers/RateLimit-Limit'
RateLimit-Remaining:
$ref: '#/components/headers/RateLimit-Remaining'
RateLimit-Reset:
$ref: '#/components/headers/RateLimit-Reset'
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/event_rsvp_index_response'
'401':
$ref: '#/components/responses/unauthorized'
'429':
$ref: '#/components/responses/rate_limited'
/api/v2/event_rsvps/{id}:
parameters:
- $ref: '#/components/parameters/id'
- $ref: '#/components/parameters/event_rsvp_show_include'
- $ref: '#/components/parameters/event_rsvp_sparse_fields'
get:
summary: Show event rsvp with provided ID
tags:
- Event Rsvps
description: Show the event RSVP matching the provided ID
operationId: showEventRsvp
responses:
'200':
description: The requested event rsvp.
headers:
RateLimit-Limit:
$ref: '#/components/headers/RateLimit-Limit'
RateLimit-Remaining:
$ref: '#/components/headers/RateLimit-Remaining'
RateLimit-Reset:
$ref: '#/components/headers/RateLimit-Reset'
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/event_rsvp_show_response'
'401':
$ref: '#/components/responses/unauthorized'
'404':
$ref: '#/components/responses/not_found'
'429':
$ref: '#/components/responses/rate_limited'
patch:
summary: Update an existing event rsvp
tags:
- Event Rsvps
description: Updates an existing event RSVP. Note that first name, last name, and email are NOT propagated to the event RSVP's signup. You must update the signup via a sidepost payload, or update the signup directly via the signup resource.
operationId: updateEventRsvp
responses:
'200':
description: The updated event rsvp.
headers:
RateLimit-Limit:
$ref: '#/components/headers/RateLimit-Limit'
RateLimit-Remaining:
$ref: '#/components/headers/RateLimit-Remaining'
RateLimit-Reset:
$ref: '#/components/headers/RateLimit-Reset'
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/event_rsvp_show_response'
'400':
$ref: '#/components/responses/bad_request'
'401':
$ref: '#/components/responses/unauthorized'
'404':
$ref: '#/components/responses/not_found'
'422':
$ref: '#/components/responses/unprocessable'
'429':
$ref: '#/components/responses/rate_limited'
requestBody:
$ref: '#/components/requestBodies/event_rsvp_update_request_body'
delete:
summary: Delete an event rsvp with provided ID
tags:
- Event Rsvps
description: Delete the event RSVP matching the provided ID
operationId: deleteEventRsvp
responses:
'200':
description: Confirmation that the event rsvp was deleted.
headers:
RateLimit-Limit:
$ref: '#/components/headers/RateLimit-Limit'
RateLimit-Remaining:
$ref: '#/components/headers/RateLimit-Remaining'
RateLimit-Reset:
$ref: '#/components/headers/RateLimit-Reset'
content:
application/vnd.api+json:
schema:
$ref: '#/components/schemas/delete_document'
'401':
$ref: '#/components/responses/unauthorized'
'404':
$ref: '#/components/responses/not_found'
'429':
$ref: '#/components/responses/rate_limited'
components:
schemas:
error_response:
description: The error body returned for 4xx and 5xx responses, with a machine-readable code and a human-readable message. Some errors include additional detail members alongside these two. The exception is 422 validation failures, which are returned as JSON:API errors documents instead.
type: object
required:
- code
- message
properties:
code:
type: string
description: Machine-readable error code identifying the failure.
examples:
- not_found
message:
type: string
description: Human-readable explanation of the failure.
examples:
- Record not found
event_rsvp_read_only_attributes:
description: The read-only attributes of a event_rsvp.
type: object
properties:
created_at:
type:
- string
- 'null'
format: date-time
examples:
- '2019-10-26T10:00:00-04:00'
updated_at:
type:
- string
- 'null'
format: date-time
examples:
- '2019-10-26T10:00:00-04:00'
show_document:
description: The JSON:API top-level document shape for responses returning a single resource under the data member.
type: object
required:
- data
properties:
data:
type: object
description: The primary resource object; each resource binds its concrete schema here via allOf composition.
included:
$ref: '#/components/schemas/included'
meta:
type: object
description: Non-standard information about the document. Empty unless the endpoint has metadata to convey.
event_rsvp_show_response:
description: A JSON:API response containing a single event rsvp.
allOf:
- $ref: '#/components/schemas/show_document'
- type: object
properties:
data:
$ref: '#/components/schemas/event_rsvp_response_data'
resource_identifier:
description: A JSON:API resource identifier object, the type/id pair that uniquely identifies a single resource.
type: object
required:
- type
- id
properties:
id:
type: string
description: Unique identifier of the resource.
examples:
- '1'
type:
type: string
description: The JSON:API resource type.
pagination_links:
description: JSON:API pagination links for the pages of a collection. A key whose page is unavailable, or that the server's pagination strategy does not provide, is omitted or null.
type: object
properties:
self:
type: string
description: Link to the current page.
examples:
- /articles?page[number]=2
first:
type:
- string
- 'null'
description: Link to the first page.
examples:
- /articles?page[number]=1
last:
type:
- string
- 'null'
description: Link to the last page.
examples:
- /articles?page[number]=5
prev:
type:
- string
- 'null'
description: Link to the previous page.
examples:
- /articles?page[number]=1
next:
type:
- string
- 'null'
description: Link to the next page.
examples:
- /articles?page[number]=3
index_document:
description: The JSON:API top-level document shape for paginated collection responses, with resource objects under data and pagination links.
type: object
required:
- data
properties:
data:
type: array
description: The page of resource objects for this collection; each resource binds its concrete item schema here via allOf composition.
links:
$ref: '#/components/schemas/pagination_links'
included:
$ref: '#/components/schemas/included'
meta:
type: object
description: Non-standard information about the document, such as requested statistics. Empty unless the endpoint has metadata to convey.
validation_error:
description: A single JSON:API error object describing a validation failure, locating the invalid field via source.pointer and carrying the model-level attribute, message, and code under meta.
type: object
properties:
code:
type: string
description: Machine-readable error code.
examples:
- unprocessable_entity
status:
type: string
description: The HTTP status code, as a string.
examples:
- '422'
title:
type: string
description: Short human-readable summary of the error type.
examples:
- Validation Error
detail:
type: string
description: Human-readable explanation specific to this failure.
examples:
- Email 'not-an-email' should look like an email address
source:
type: object
properties:
pointer:
type: string
description: JSON Pointer to the request document member the error relates to.
examples:
- /data/attributes/email
meta:
type: object
description: The underlying model validation error, including the attribute name, message, and code. Errors on sideposted resources nest these members under a relationship key.
properties:
attribute:
type: string
description: The attribute that failed validation.
message:
type: string
description: The validation failure message.
code:
type: string
description: The validation failure code.
event_rsvp_update_request:
description: The request body for updating an existing event rsvp.
allOf:
- $ref: '#/components/schemas/update_request_document'
- type: object
properties:
data:
type: object
properties:
id:
type: string
examples:
- '1'
type:
const: event_rsvps
examples:
- event_rsvps
attributes:
allOf:
- $ref: '#/components/schemas/event_rsvp_read_write_attributes'
- $ref: '#/components/schemas/event_rsvp_write_only_attributes'
event_rsvp_write_only_attributes:
description: The write-only attributes of a event_rsvp.
type: object
properties:
billing_address_attributes:
type:
- object
- 'null'
examples:
- 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'
description: " Attribute used to write data to the given event_rsvp's Billing address.\n When an address already exists, provided values will be used to patch the existing address data,\n only overwriting values provided in the payload.\n When no address exists, the existing data will be used to persist a new address.\n"
home_address_attributes:
type:
- object
- 'null'
examples:
- 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'
description: " Attribute used to write data to the given event_rsvp's Home address.\n When an address already exists, provided values will be used to patch the existing address data,\n only overwriting values provided in the payload.\n When no address exists, the existing data will be used to persist a new address.\n"
mailing_address_attributes:
type:
- object
- 'null'
examples:
- 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'
description: " Attribute used to write data to the given event_rsvp's Mailing address.\n When an address already exists, provided values will be used to patch the existing address data,\n only overwriting values provided in the payload.\n When no address exists, the existing data will be used to persist a new address.\n"
phone_number:
type:
- string
- 'null'
examples:
- '5555555555'
description: The attendee's phone number
registered_address_attributes:
type:
- object
- 'null'
examples:
- 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'
description: " Attribute used to write data to the given event_rsvp's Registered address.\n When an address already exists, provided values will be used to patch the existing address data,\n only overwriting values provided in the payload.\n When no address exists, the existing data will be used to persist a new address.\n"
user_submitted_address_attributes:
type:
- object
- 'null'
examples:
- 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'
description: " Attribute used to write data to the given event_rsvp's User submitted address.\n When an address already exists, provided values will be used to patch the existing address data,\n only overwriting values provided in the payload.\n When no address exists, the existing data will be used to persist a new address.\n"
work_address_attributes:
type:
- object
- 'null'
examples:
- 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'
description: " Attribute used to write data to the given event_rsvp's Work address.\n When an address already exists, provided values will be used to patch the existing address data,\n only overwriting values provided in the payload.\n When no address exists, the existing data will be used to persist a new address.\n"
event_rsvp_response_data:
description: The JSON:API resource object representing a event rsvp.
allOf:
- $ref: '#/components/schemas/resource_identifier'
- type: object
properties:
type:
const: event_rsvps
examples:
- event_rsvps
attributes:
allOf:
- $ref: '#/components/schemas/event_rsvp_read_write_attributes'
- $ref: '#/components/schemas/event_rsvp_read_only_attributes'
delete_document:
examples:
- meta: {}
description: The successful destroy response, an empty JSON:API meta-only document returned with status 200 (rather than JSON:API's commonly used 204 No Content).
type: object
required:
- meta
additionalProperties: false
properties:
meta:
examples:
- {}
type: object
properties: {}
rate_limited_response:
description: The body returned by the rate limiter when an access token exceeds its request quota.
type: object
required:
- message
properties:
message:
type: string
description: Human-readable explanation of the rate limit.
examples:
- You have made too many requests. Please try again later.
validation_error_document:
description: The JSON:API errors document returned with status 422 when model validations fail on create or update. Unlike this API's flat 4xx error bodies, validation failures follow the JSON:API errors format.
type: object
required:
- errors
properties:
errors:
type: array
minItems: 1
items:
$ref: '#/components/schemas/validation_error'
event_rsvp_create_request:
description: The request body for creating a new event rsvp.
allOf:
- $ref: '#/components/schemas/create_request_document'
- type: object
properties:
data:
type: object
properties:
type:
const: event_rsvps
examples:
- event_rsvps
attributes:
allOf:
- $ref: '#/components/schemas/event_rsvp_read_write_attributes'
- $ref: '#/components/schemas/event_rsvp_write_only_attributes'
update_request_document:
description: The JSON:API top-level document shape for update requests, whose data member identifies the resource by type and id and carries the changed attributes.
type: object
required:
- data
properties:
data:
type: object
required:
- type
- id
properties:
id:
type: string
description: The ID of the resource being updated.
type:
type: string
description: The JSON:API resource type of the resource being updated.
create_request_document:
description: The JSON:API top-level document shape for create requests, whose data member carries the new resource's type and attributes.
type: object
required:
- data
properties:
data:
type: object
required:
- type
properties:
type:
type: string
description: The JSON:API resource type of the resource being created.
event_rsvp_sideload_values:
description: Relationship names that can be sideloaded with the include query parameter on event_rsvp endpoints.
type: string
enum:
- author
- event
- event_ticket_level
- recruiter
- signup
event_rsvp_field_values:
description: Readable event_rsvp attribute names selectable with sparse fieldsets (fields[event_rsvps]).
type: string
enum:
- amount_in_cents
- attendee
- canceled
- created_at
- email
- event_id
- first_name
- guests_count
- last_name
- page_id
- prepaid
- private
- tickets_count
- updated_at
- volunteer
resource:
description: A generic JSON:API resource object. Resources sideloaded in a document's included member use this shape; their attributes are those of the resource type named in the type member.
allOf:
- $ref: '#/components/schemas/resource_identifier'
- type: object
properties:
attributes:
type: object
description: The attributes of the resource, as documented for its resource type.
relationships:
type: object
description: References from this resource to other resources in the document.
included:
description: Sideloaded resources requested via the include query parameter. Each entry is a full resource object whose shape is documented under its own resource type.
type: array
items:
$ref: '#/components/schemas/resource'
event_rsvp_index_response:
description: A paginated JSON:API response containing a list of event rsvps.
allOf:
- $ref: '#/components/schemas/index_document'
- type: object
properties:
data:
type: array
items:
$ref: '#/components/schemas/event_rsvp_response_data'
event_rsvp_read_write_attributes:
description: The attributes of a event_rsvp that can be both read and written.
type: object
properties:
amount_in_cents:
type:
- integer
- 'null'
examples:
- 350
description: The cost of the RSVP in cents.
attendee:
type:
- boolean
- 'null'
examples:
- false
description: The signup is attending the event.
canceled:
type:
- boolean
- 'null'
examples:
- false
description: The RSVP was canceled.
email:
type:
- string
- 'null'
examples:
- lucille.ball@example.com
description: The email address of the attendee.
event_id:
type:
- string
- 'null'
examples:
- '1'
description: The associated event.
first_name:
type:
- string
- 'null'
examples:
- Lucille
description: The attendee's first name.
guests_count:
type:
- integer
- 'null'
examples:
- 19
description: Number of guests on the RSVP.
last_name:
type:
- string
- 'null'
examples:
- Ball
description: The attendee's last name.
page_id:
type:
- string
- 'null'
examples:
- '1'
description: The associated page.
prepaid:
type:
- boolean
- 'null'
examples:
- false
description: The RSVP has already been paid.
private:
type:
- boolean
- 'null'
examples:
- false
description: The RSVP is private.
tickets_count:
type:
- integer
- 'null'
examples:
- 45
description: Number of tickets sold with this RSVP.
volunteer:
type:
- boolean
- 'null'
examples:
- false
description: The attendee is a volunteer.
parameters:
pagination_size:
name: page[size]
description: 'Number of results to display per page (default: 20, max: 100, min: 1)'
in: query
required: false
schema:
type: string
default: '20'
id:
name: id
in: path
description: id
required: true
schema:
type: string
event_rsvp_index_include:
name: include
in: query
description: 'Comma-delimited list of sideloaded resources to include as part of the event rsvp index response.
See guidance [here](https://support.nationbuilder.com/en/articles/9899245-api-v2-walkthrough#h_2d5333adab) about
sideloading large numbers of resources and pagination.
'
schema:
type: array
default: []
uniqueItems: true
items:
$ref: '#/components/schemas/event_rsvp_sideload_values'
required: false
style: form
explode: false
event_rsvp_sparse_fields:
name: fields[event_rsvps]
in: query
required: false
description: Comma-delimited list of event rsvp attributes to only return in the response
schema:
type: array
default: []
uniqueItems: true
items:
$ref: '#/components/schemas/event_rsvp_field_values'
style: form
explode: false
event_rsvp_show_include:
name: include
in: query
description: 'Comma-delimited list of sideloaded resources to include as part of the event rsvp response.
See guidance [here](https://support.nationbuilder.com/en/articles/9899245-api-v2-walkthrough#h_2d5333adab) about
sideloading large numbers of resources and pagination.
'
schema:
type: array
default: []
uniqueItems: true
items:
$ref: '#/components/schemas/event_rsvp_sideload_values'
required: false
style: form
explode: false
pagination_number:
name: page[number]
description: Page number to list (starting at 1)
in: query
required: false
schema:
type: string
default: '1'
headers:
RateLimit-Remaining:
description: Number of requests remaining for the current access token in the current rate-limit window.
schema:
type: string
examples:
- '249'
examples: {}
Retry-After:
description: Number of seconds to wait before retrying. Sent with 429 responses.
schema:
type: string
examples:
- '10'
examples: {}
RateLimit-Limit:
descripti
# --- truncated at 32 KB (36 KB total) ---
# Full source: https://raw.githubusercontent.com/api-evangelist/nationbuilder/refs/heads/main/openapi/nationbuilder-event-rsvps-api-openapi.yml