Create a Follow Up

This endpoint allows you to create a Follow Up record by providing core information such as the entity the Follow Up relates to and optionally the content/body of the Follow Up.

post/follow-ups

Request

Base URL
https://street.co.uk/open-api/v1
Auth
HTTP bearer
TypeScript
https://skmtc.dev/street/apis/street-open-api/docs/follow-ups/post.ts
A function with typed inputs. Its response is checked against the schema.

Request body

Response

Created.

Example response

{
  "data": {
    "relationships": {
      "branch": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "negotiator": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "property": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "sale": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "salesApplicant": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "lettingsApplicant": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "valuation": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      },
      "viewing": {
        "data": {
          "id": "a827a3ae-4c74-4c32-8b42-42248d4010d3"
        }
      }
    }
  }
}

Changes

No recorded changes to this operation across all 7 revisions of this API.