Skip to content

Updating an existing Organization Membership

Request

This endpoint returns structured Organization Membership objects. As with all Kantata OX API endpoints, the returned data will be referenced in sorted order in the results array and will be indexed by ID in the organization_memberships top-level JSON key. Please see our Response Format section for more information.

Path
idintegerrequired

The ID of the Model.

Query
includestring

Any of the below associations can be included in your request by providing the include param, e.g. include=association1,association2.

  • department (Organization) - The department of the associated member.
  • geography (Organization) - The geography of the associated member.
optional_fieldsArray of strings

Allows you to request one or more optional fields as an array.

Items Enum:"effective_start_date""effective_end_date"
Bodyapplication/jsonrequired
organization_membershipobject
{
  "organization_membership": {
    "geography_id": 0,
    "department_id": 0
  }
}

Responses

Organization Membership has been updated.

Bodyapplication/json
countinteger, (int32)
metaobject
resultsArray of objects
organization_membershipsobject
organizationsobject
Response
{
  "count": 0,
  "meta": {
    "count": 0,
    "page_count": 0,
    "page_number": 0,
    "page_size": 0
  },
  "results": [
    {
      "key": "string",
      "id": "string"
    }
  ],
  "organization_memberships": {
    "property1": {
      "created_at": "2019-08-24T14:15:22Z",
      "department_id": "string",
      "effective_end_date": "2019-08-24",
      "effective_start_date": "2019-08-24",
      "geography_id": "string",
      "member_id": "string",
      "member_type": "string",
      "primary": true,
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "created_at": "2019-08-24T14:15:22Z",
      "department_id": "string",
      "effective_end_date": "2019-08-24",
      "effective_start_date": "2019-08-24",
      "geography_id": "string",
      "member_id": "string",
      "member_type": "string",
      "primary": true,
      "updated_at": "2019-08-24T14:15:22Z"
    }
  },
  "organizations": {
    "property1": {
      "ancestor_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "parent_id": "string",
      "type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    },
    "property2": {
      "ancestor_ids": [
        "string"
      ],
      "created_at": "2019-08-24T14:15:22Z",
      "name": "string",
      "parent_id": "string",
      "type": "string",
      "updated_at": "2019-08-24T14:15:22Z"
    }
  }
}