NAnationbuilder
Relationships

Update an existing relationship

Changed on

Updates an existing relationship. Valid relationship types are affiliate-affiliate, alum-school, assistant-assisted, board_member-organization, candidate-committee, chapter-parent, child-parent, consultant-organization, employee-employer, family_partner-family_partner, friend-friend, member-organization, mentee-mentor, partner-partner, primary_contact-organization, relative-relative, representative-constituent, resident-organization, sibling-sibling, spouse-spouse, student-school, student-teacher, subordinate-manager, subsidiary-parent, treasurer-committee. first_signup_id corresponds with the ID of the signup on the first role listed, and second_signup_id corresponds with the ID of the signup on the second role listed in the relationship type.

patch/api/v2/relationships/{id}

Request

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

Request body

Example request

{
  "data": {
    "id": "1",
    "type": "relationships",
    "attributes": {
      "first_signup_id": "1",
      "relationship_type": "member-organization",
      "second_signup_id": "2",
      "title": "Executive Assistant"
    }
  }
}

Response

The updated relationship.

metaobject

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

Example response

{
  "data": {
    "id": "1",
    "type": "relationships",
    "attributes": {
      "first_signup_id": "1",
      "relationship_type": "member-organization",
      "second_signup_id": "2",
      "title": "Executive Assistant",
      "created_at": "2019-10-26T10:00:00-04:00",
      "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

    • info

      added the non-success response with the status