---
title: "Create a pledge"
method: POST
path: "/api/v2/pledges"
tags: ["Pledges"]
---

# Create a pledge

`POST /api/v2/pledges`

## Request

- Base URL: `https://yournation.nationbuilder.com`
- URL: `https://yournation.nationbuilder.com/api/v2/pledges`
- Auth: HTTP bearer

Creates a pledge from given data

## Request body

- PledgeCreateRequest: The JSON:API top-level document shape for create requests, whose data member carries the new resource's type and attributes.
  - `data` object, required
    - `type` 'pledges', required: The JSON:API resource type of the resource being created.
    - `attributes` PledgeReadWriteAttributes: The attributes of a pledge that can be both read and written.
      - `amount_in_cents` integer, nullable: The amount of cents pledged.
      - `author_id` string, nullable: The author of the pledge.
      - `donation_tracking_code_id` string, nullable: The associated donation tracking code.
      - `is_private` boolean, nullable: Private pledges are not displayed on the site.
      - `page_id` string, nullable: The page this pledge belongs to.
      - `recruiter_id` string, nullable: The recruiter of the pledge.
      - `signup_id` string, nullable: The signup is the person that made the pledge.

## Response `201`

The newly created pledge.

- PledgeShowResponse: The JSON:API top-level document shape for responses returning a single resource under the data member.
  - `data` object, required: A JSON:API resource identifier object, the type/id pair that uniquely identifies a single resource.
    - `id` string, required: Unique identifier of the resource.
    - `type` 'pledges', required: The JSON:API resource type.
    - `attributes` object: The read-only attributes of a pledge.
      - `amount_in_cents` integer, nullable: The amount of cents pledged.
      - `author_id` string, nullable: The author of the pledge.
      - `donation_tracking_code_id` string, nullable: The associated donation tracking code.
      - `is_private` boolean, nullable: Private pledges are not displayed on the site.
      - `page_id` string, nullable: The page this pledge belongs to.
      - `recruiter_id` string, nullable: The recruiter of the pledge.
      - `signup_id` string, nullable: The signup is the person that made the pledge.
      - `amount` string, nullable: Formatted amount of the pledge.
      - `amount_left_in_cents` integer, nullable: Amount donated by the signup minus the amount pledged.
      - `created_at` string, date-time, nullable
      - `updated_at` string, date-time, nullable
  - `included` Resource[]: Sideloaded resources requested via the include query parameter. Each entry is a full resource object whose shape is documented under its own resource type.
    - `id` string, required: Unique identifier of the resource.
    - `type` string, required: The JSON:API resource type.
    - `attributes` object: The attributes of the resource, as documented for its resource type.
    - `relationships` object: References from this resource to other resources in the document.
  - `meta` object: Non-standard information about the document. Empty unless the endpoint has metadata to convey.

## Other responses

- `400`: The request body or query parameters are invalid, such as an unknown attribute, filter, filter operator, sort field, or sideload.
- `401`: The access token is missing, expired, or not authorized to access this resource.
- `422`: Model validations failed for the resource being created or updated. Unlike this API's other errors, validation failures are returned as a JSON:API errors document locating each invalid field.
- `429`: The access token has exceeded its request quota for the current rate-limit window.

## Changes

- **2026-11-05** `d5c88ca497ac`: 4 breaking, 1 warning, 7 info
  - added `#/components/schemas/create_request_document, subschema #2` to the request body `allOf` list
  - the request's body type changed from `object` to no type
  - the response's body type changed from `object` to no type for status `201`
  - removed the required property `data` from the response with the `201` status
  - …8 more

[Operation history](https://skmtc.dev/nationbuilder/apis/nationbuilder-v2-api/changes/api/v2/pledges/post.md)

---

[API](https://skmtc.dev/nationbuilder/apis/nationbuilder-v2-api.md) - [All operations](https://skmtc.dev/nationbuilder/apis/nationbuilder-v2-api/llms.txt) - [OpenAPI document](https://skmtc.dev/nationbuilder/apis/nationbuilder-v2-api/revisions/d5c88ca497ac?raw)