NAnationbuilder
Memberships

Create a membership

Changed on

Creates a membership from given data

post/api/v2/memberships

Request

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

Request body

Example request

{
  "data": {
    "type": "memberships",
    "attributes": {
      "expires_on": "2024-10-04",
      "grace_period_num_time_periods": 7,
      "grace_period_time_period_type": "days",
      "membership_type_id": "1",
      "signup_id": "1",
      "started_at": "2019-10-26T10:00:00-04:00",
      "status": "active",
      "status_reason": "Does not want to pay anymore",
      "activity_author_id": "1"
    }
  }
}

Response

The newly created membership.

metaobject

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

Example response

{
  "data": {
    "id": "1",
    "type": "memberships",
    "attributes": {
      "expires_on": "2024-10-04",
      "grace_period_num_time_periods": 7,
      "grace_period_time_period_type": "days",
      "membership_type_id": "1",
      "signup_id": "1",
      "started_at": "2019-10-26T10:00:00-04:00",
      "status": "active",
      "status_reason": "Does not want to pay anymore",
      "created_at": "2019-10-26T10:00:00-04:00",
      "suspended_at": "2022-10-11",
      "updated_at": "2019-10-26T10:00:00-04:00"
    }
  },
  "included": [
    {
      "id": "1"
    }
  ]
}

Changes

  • d5c88ca497acRevision 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