Sign in
latestOpenAPI 3.0.02026-08-10135177718.4 KB

f739db716aaf

Relationships

Update a relationship

put/relationships/{id}

Path parameters

idinteger required

A single ID

Request body

fieldsstring

Example request

{
  "fields": "all"
}

Response

A list of relationships

total_resultsinteger required
pageinteger required
per_pageinteger required

Example response

{
  "results": [
    {
      "user": {
        "site": {
          "id": 1,
          "icon_url": "https://static.inaturalist.org/sites/1-logo_square.png",
          "locale": "en",
          "name": "iNaturalist",
          "site_name_short": "iNat",
          "url": "https://www.inaturalist.org"
        }
      },
      "friend_user": {
        "site": {
          "id": 1,
          "icon_url": "https://static.inaturalist.org/sites/1-logo_square.png",
          "locale": "en",
          "name": "iNaturalist",
          "site_name_short": "iNat",
          "url": "https://www.inaturalist.org"
        }
      }
    }
  ]
}