Get /api/v2/follows/:id
Show a follow

Params

Param name Description
id
required

Follow ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


POST /api/v2/follows
Following a followable

Examples

POST /api/v2/follows
{
  "data": {
    "type": "follows",
    "relationships": {
      "followable": {
        "data": {
          "type": "insights",
          "id": "184"
        }
      }
    }
  }
}
201
{
  "data": {
    "id": "36",
    "type": "follows",
    "links": {
      "self": "http://test.host/api/v2/follows/36"
    },
    "relationships": {
      "followable": {
        "links": {
          "self": "http://test.host/api/v2/follows/36/relationships/followable",
          "related": "http://test.host/api/v2/follows/36/followable"
        }
      },
      "follower": {
        "links": {
          "self": "http://test.host/api/v2/follows/36/relationships/follower",
          "related": "http://test.host/api/v2/follows/36/follower"
        }
      }
    }
  }
}

Params

Param name Description
data
required

Follow information

Validations:

  • Must be a Hash

data[type]
required

Validations:

data[relationships]
required

Validations:

  • Must be a Hash

data[relationships][followable]
required

Validations:

  • Must be a Hash

data[relationships][followable][data]
required

Validations:

  • Must be a Hash

data[relationships][followable][data][type]
required

Followable being followed on, which could be `insights`, or `accounts`

Validations:

  • Must be a String

data[relationships][followable][data][id]
required

Followable ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.


DELETE /api/v2/follows/:id
Unfollow followable

Examples

DELETE /api/v2/follows/30
204
{}

Params

Param name Description
id
required

Follow ID

Validations:

  • Must be an identifier, string from 1 to 128 characters containing only alphanumeric characters, space, underscore(_), hyphen(-) with no leading or trailing space.