Create application feedback

POST

https://api.sureshake.com/v2/hiring/applications/{id}/feedback

Path parameters

id
string
required
format: uuid

Request body JSON required

entityId
string
required
format: uuid
summary
string
required
maxLength: 2000 · minLength: 1
candidateVisible
optional
boolean
default: true
tags
optional
object
- strengths
  optional
  array of
  string
- gaps
  optional
  array of
  string
- recommendations
  optional
  array of
  string
}

Returns

200

Default Response

JSON

data
object
required
- id
  string
  required
  format: uuid
- entityId
  string
  required
  format: uuid
- applicationId
  string
  required
  format: uuid
- candidateVisible
  boolean
  required
- summary
  string
  or null
  required
- tags
  object
  or null
  required
  strengths
  optional
  array of
  string
  gaps
  optional
  array of
  string
  recommendations
  optional
  array of
  string
- publishedAt
  string
  required
  format: date-time
- createdAt
  string
  required
  format: date-time
}
meta
optional
object
- timestamp
  string
  required
  format: date-time
}

400

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

401

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

403

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

404

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

409

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

500

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

503

Default Response

JSON

error
object
required
- code
  string
  required
  Machine-readable error code (e.g., NOT_FOUND)
- message
  string
  required
  Human-readable error message
- details
  optional
  unknown
  Optional structured error details
- traceId
  optional
  string
  Unique ID for log correlation
}

Create application feedback

curl --request POST \
  --url 'https://api.sureshake.com/v2/hiring/applications/<id>/feedback' \
  --header 'Content-Type: application/json' \
  --data '
{
  "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
  "summary": "string",
  "candidateVisible": true,
  "tags": {
    "strengths": [
      "string"
    ],
    "gaps": [
      "string"
    ],
    "recommendations": [
      "string"
    ]
  }
}
'

const url = 'https://api.sureshake.com/v2/hiring/applications/<id>/feedback';
const options = {
  method: 'POST',
  headers: {'Content-Type': 'application/json'},
  body: JSON.stringify({
    entityId: '156e622c-6cdf-4c27-9bc9-2f2db69919f5',
    summary: 'string',
    candidateVisible: true,
    tags: {strengths: ['string'], gaps: ['string'], recommendations: ['string']}
  })
};

fetch(url, options)
  .then(res => res.json())
  .then(json => console.log(json))
  .catch(err => console.error(err));

import requests

url = "https://api.sureshake.com/v2/hiring/applications/<id>/feedback"

payload = {
    "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
    "summary": "string",
    "candidateVisible": True,
    "tags": {
        "strengths": ["string"],
        "gaps": ["string"],
        "recommendations": ["string"]
    }
}
headers = {"Content-Type": "application/json"}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

Response example

{
  "data": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "entityId": "156e622c-6cdf-4c27-9bc9-2f2db69919f5",
    "applicationId": "97ab27fa-30e2-43e3-92a3-160e80f4c0d5",
    "candidateVisible": true,
    "summary": "string",
    "tags": {
      "strengths": [
        "string"
      ],
      "gaps": [
        "string"
      ],
      "recommendations": [
        "string"
      ]
    },
    "publishedAt": "2019-08-24T14:15:22Z",
    "createdAt": "2019-08-24T14:15:22Z"
  },
  "meta": {
    "timestamp": "2019-08-24T14:15:22Z"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}

{
  "error": {
    "code": "string",
    "message": "string",
    "details": null,
    "traceId": "string"
  }
}