--- updatedAt: 2026-04-27T22:41:20.000Z agentTools: projectIndex: https://developers.pinpointhq.com/llms.txt --- # Update Interview Currently the only attribute you are able to update on an interview is the summary. We expect the summary in HTML format. The following html elements are allowed: \ \ \
\
\ \ \
\ \

\

\

\

\
\
\ \ \
  • \ \
      \

      \ \ \ \ \ \ \ \
        # OpenAPI definition ````json { "openapi": "3.0.1", "info": { "contact": { "email": "integrations@pinpointhq.com", "name": "Pinpoint Integrations" }, "description": "Documentation for Pinpoint External API endpoints", "title": "Pinpoint External API Reference", "version": "v1.0.27" }, "security": [ { "ApiKeyAuth": [] } ], "x-readme": { "samples-languages": [ "curl", "python", "ruby" ] }, "servers": [ { "url": "https://{subdomain}.pinpointhq.com", "description": "Pinpoint Production Environment", "variables": { "subdomain": { "default": "your-subdomain", "description": "Subdomain" } } } ], "components": { "securitySchemes": { "ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-KEY" } }, "responses": { "400": { "description": "Bad Request", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/jsonapi_failure" }, "examples": { "invalid_param": { "description": "Malformed query params", "value": { "errors": [ { "code": "bad_request", "status": "400", "title": "Bad Request", "detail": "Malformed query params" } ] } }, "invalid_locale": { "description": "Invalid locale", "value": { "errors": [ { "code": "bad_request", "status": "400", "title": "Bad Request", "detail": "{locale} is not a valid locale" } ] } } } } } }, "401": { "description": "Unauthorized", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/jsonapi_failure" }, "examples": { "api_key_not_provided": { "description": "X-API-KEY header not provided", "value": { "errors": [ { "code": "unauthorized", "status": "401", "title": "Unauthorized", "detail": "X-API-KEY header not provided" } ] } }, "invalid_api_key": { "description": "Invalid API key", "value": { "errors": [ { "code": "unauthorized", "status": "401", "title": "Unauthorized", "detail": "Invalid API key" } ] } } } } } }, "403": { "description": "Forbidden", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/jsonapi_failure" }, "examples": { "integration_not_enabled": { "description": "Integration not enabled", "value": { "errors": [ { "code": "forbidden", "status": "403", "title": "Forbidden", "detail": "Integration not enabled" } ] } } } } } }, "404": { "description": "Not Found", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/jsonapi_failure" }, "examples": { "not_found": { "description": "Record not found", "value": { "errors": [ { "code": "not_found", "status": "404", "title": "Not Found", "detail": "Record not found" } ] } } } } } }, "422": { "description": "Unprocessable Entity", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/jsonapi_failure" }, "examples": { "not_found": { "description": "Unprocessable Entity", "value": { "errors": [ { "code": "unprocessable_entity", "status": "422", "title": "Validation Error", "detail": "{attribute_name} can't be blank" } ] } } } } } }, "429": { "description": "Too Many Requests", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/jsonapi_failure" }, "examples": { "not_found": { "description": "Too Many Requests", "value": { "errors": [ { "code": "too_many_requests", "status": "429", "title": "Too Many Requests", "detail": "Rate limit exceeded" } ] } } } } } }, "500": { "description": "Internal Server Error", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/jsonapi_failure" }, "examples": { "not_found": { "description": "Internal Server Error", "value": { "errors": [ { "code": "internal_server_error", "status": "500", "title": "Internal Server Error", "detail": "We've notified our engineers and hope to address this issue shortly." } ] } } } } } }, "interviews_200": { "description": "OK: Interview resource", "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/interviews_single" }, "examples": { "jsonapi": { "$ref": "#/components/examples/jsonapi_interviews_single" } } } }, "links": { "get-interview-id": { "$ref": "#/components/links/get-interview-id" }, "update-interview-id": { "$ref": "#/components/links/update-interview-id" }, "delete-interview-id": { "$ref": "#/components/links/delete-interview-id" } } } }, "schemas": { "applications": { "type": "object", "description": "Application attributes", "properties": { "uuid": { "type": "string", "description": "A stable UUID for this application. Safe to share with third-party integrations as a unique application identifier.", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "candidate_id": { "type": "integer", "readOnly": true }, "external_system_reference": { "type": "string", "description": "Used to store the ID or reference from an external system that the record was created from." }, "hired_at": { "type": "string", "format": "date-time" }, "internal_candidate": { "type": "boolean", "readOnly": true }, "job_id": { "type": "integer", "readOnly": true }, "job_posting_id": { "type": "integer", "description": "The posting the candidate applied through. Blank for applications created outside a careers site posting form, such as those created through this API or by an integration.", "readOnly": true }, "locale": { "type": "string" }, "stage_id": { "type": "integer", "readOnly": true }, "rejected_at": { "type": "string", "format": "date-time", "readOnly": true }, "phone_iso2": { "type": "string" }, "start_on": { "type": "string", "format": "date" }, "equality_monitoring_option_ids": { "type": "array", "items": {}, "writeOnly": true }, "skip_notifications_on_create": { "type": "boolean", "writeOnly": true }, "is_demo": { "type": "boolean" }, "add_tag_with_context": { "type": "object", "additionalProperties": true, "writeOnly": true }, "add_tags_with_context": { "type": "array", "items": {}, "description": "Add multiple **tags** at once\nExample: `[{\"tag\": \"Celery\", \"context\": \"custom_green\"}, {\"tag\": \"Availability\", \"context\": \"rejection\"}]`", "writeOnly": true }, "remove_tag_with_context": { "type": "object", "additionalProperties": true, "writeOnly": true }, "cv_base64_data": { "type": "string", "writeOnly": true }, "cv_base64_filename": { "type": "string", "writeOnly": true }, "cover_letter_base64_data": { "type": "string", "description": "Base64-encoded cover letter file content, including the data URI prefix (e.g. `data:application/pdf;base64,...`).", "writeOnly": true }, "cover_letter_base64_filename": { "type": "string", "description": "Original filename for the cover letter, e.g. `cover_letter.pdf`. Accepted file types: `pdf`, `doc`, `docx`, `txt`, `rtf`. Maximum file size: **30 MB**.", "writeOnly": true }, "documents_base64": { "type": "array", "items": {}, "description": "Array of documents to attach. Each item must be an object with the following fields:\n\n```\n[\n {\n \"data\": \"[Base64 encoded file content, including data URI prefix]\",\n \"filename\": \"[Original filename, e.g. report.pdf]\"\n }\n]\n```\n\nAccepted file types: `pdf`, `doc`, `docx`, `png`, `jpeg`, `xls`, `xlsx`, `pptx`, `mp4`, `mov`, `txt`.\nMaximum file size: **10 MB** per file.\n", "writeOnly": true }, "cv_signed_id": { "type": "string", "writeOnly": true }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "preferred_name": { "type": "string" }, "email": { "type": "string" }, "phone": { "type": "string" }, "date_of_birth": { "type": "string" }, "linkedin_url": { "type": "string" }, "summary": { "type": "string" }, "preferred_pronouns": { "type": "string" }, "channel_source": { "type": "string" }, "address1": { "type": "string" }, "address2": { "type": "string", "description": "Address line 2 for non-US addresses. Returns `null` for US addresses. Writing this attribute is not supported when `country` is `US`." }, "town": { "type": "string" }, "state_province": { "type": "string", "description": "State or province for US addresses. Returns `null` for non-US addresses. Writing this attribute is only supported when `country` is `US`." }, "postcode": { "type": "string" }, "country": { "type": "string" }, "country_code": { "type": "string", "readOnly": true }, "country_code_alpha3": { "type": "string", "readOnly": true }, "country_name": { "type": "string", "readOnly": true }, "full_name": { "type": "string", "readOnly": true }, "national_identifier": { "type": "string", "readOnly": true }, "channel": { "type": "string" }, "concealed": { "type": "boolean", "readOnly": true }, "ai_score": { "type": "object", "additionalProperties": true, "description": "AI-generated score for the application. Only returned when AI Match Score is enabled for the company.\n`null` when AI Match Score is disabled or no score exists for this application.\n\nExample:\n```\n{\n \"status\": \"completed\",\n \"score\": 87,\n \"verdict\": \"Strong match for the role\",\n \"strengths\": [\"Relevant experience\", \"Strong technical skills\"],\n \"concerns\": [\"Limited management experience\"],\n \"interview_focus\": [\"Leadership scenarios\"],\n \"scored_at\": \"2026-04-01T10:00:00Z\"\n}\n```\n", "readOnly": true }, "create_pdf_application": { "type": "boolean", "writeOnly": true }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" } } }, "description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)", "readOnly": true }, "average_rating": { "type": "number", "format": "float", "description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)", "readOnly": true }, "tags": { "type": "array", "items": {}, "description": "A list of tags assigned to the application.\nExample: `[{\"context\": \"custom_green\", \"name\": \"Celery\"}, {\"context\": \"rejection\", \"name\": \"Availability\"}]`\n. This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)", "readOnly": true }, "days_in_current_stage": { "type": "integer", "description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)", "readOnly": true } }, "additionalProperties": false }, "applications_relationships": { "type": "object", "properties": { "job": { "type": "object", "properties": { "data": { "description": "References to other resource objects in a to-one (\"relationship\").", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "jobs", "enum": [ "jobs" ] }, "id": { "type": "string", "example": "1" } } }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "job_posting": { "type": "object", "properties": { "data": { "description": "References to other resource objects in a to-one (\"relationship\").", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "job_postings", "enum": [ "job_postings" ] }, "id": { "type": "string", "example": "1" } } }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "stage": { "type": "object", "properties": { "data": { "description": "References to other resource objects in a to-one (\"relationship\").", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "stages", "enum": [ "stages" ] }, "id": { "type": "string", "example": "1" } } }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "furthest_stage": { "type": "object", "properties": { "data": { "description": "References to other resource objects in a to-one (\"relationship\").", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "stages", "enum": [ "stages" ] }, "id": { "type": "string", "example": "1" } } }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "candidate": { "type": "object", "properties": { "data": { "description": "References to other resource objects in a to-one (\"relationship\").", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "candidates", "enum": [ "candidates" ] }, "id": { "type": "string", "example": "1" } } }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "hris_reference": { "type": "object", "properties": { "data": { "description": "References to other resource objects in a to-one (\"relationship\").", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "hris_exports", "enum": [ "hris_exports" ] }, "id": { "type": "string", "example": "1" } } }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "onboarding_application": { "type": "object", "properties": { "data": { "description": "References to other resource objects in a to-one (\"relationship\").", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "onboarding_applications", "enum": [ "onboarding_applications" ] }, "id": { "type": "string", "example": "1" } } }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "document_requests": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "document_requests", "enum": [ "document_requests" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "offers": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "offers", "enum": [ "offers" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "answers": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "answers", "enum": [ "answers" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "custom_attributes": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "custom_attributes", "enum": [ "custom_attributes" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "structured_section_responses": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "structured_section_responses", "enum": [ "structured_section_responses" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "scorecard_ratings": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "scorecard_ratings", "enum": [ "scorecard_ratings" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "scorecard_notes": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "scorecard_notes", "enum": [ "scorecard_notes" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "scorecard_answers": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "scorecard_answers", "enum": [ "scorecard_answers" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "user_scorecards": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "user_scorecards", "enum": [ "user_scorecards" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "comments": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "comments", "enum": [ "comments" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "resume": { "type": "object", "properties": { "data": { "description": "References to other resource objects in a to-one (\"relationship\").", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "resumes", "enum": [ "resumes" ] }, "id": { "type": "string", "example": "1" } } }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } } }, "additionalProperties": false }, "applications_resource": { "type": "object", "properties": { "id": { "type": "string", "example": "1" }, "type": { "type": "string", "enum": [ "applications" ] }, "attributes": { "$ref": "#/components/schemas/applications" }, "relationships": { "$ref": "#/components/schemas/applications_relationships" } }, "additionalProperties": false }, "interview_parts": { "type": "object", "description": "Interview Part attributes", "properties": { "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "company_id": { "type": "integer", "readOnly": true }, "conferencing_join_url": { "type": "string", "readOnly": true }, "conferencing_provider_name": { "type": "string", "readOnly": true }, "interview_id": { "type": "integer", "readOnly": true }, "position": { "type": "integer", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true } }, "additionalProperties": false }, "interview_parts_attributes_put": { "type": "object", "description": "Interview Part put attributes", "additionalProperties": false }, "interview_parts_relationships": { "type": "object", "properties": { "interview": { "type": "object", "properties": { "data": { "description": "References to other resource objects in a to-one (\"relationship\").", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "interviews", "enum": [ "interviews" ] }, "id": { "type": "string", "example": "1" } } }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "interviewing_users": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "users", "enum": [ "users" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } } }, "additionalProperties": false }, "interview_parts_resource": { "type": "object", "properties": { "id": { "type": "string", "example": "1" }, "type": { "type": "string", "enum": [ "interview_parts" ] }, "attributes": { "$ref": "#/components/schemas/interview_parts" }, "relationships": { "$ref": "#/components/schemas/interview_parts_relationships" } }, "additionalProperties": false }, "interviews": { "type": "object", "description": "Interview attributes", "properties": { "start_at": { "type": "string", "format": "date-time", "readOnly": true }, "end_at": { "type": "string", "format": "date-time", "readOnly": true }, "interviewable_id": { "type": "integer", "readOnly": true }, "interviewable_type": { "type": "string", "readOnly": true }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "status": { "type": "string", "readOnly": true }, "summary": { "type": "string" }, "presence": { "type": "string", "readOnly": true } }, "additionalProperties": false }, "interviews_attributes_put": { "type": "object", "description": "Interview put attributes", "properties": { "summary": { "type": "string" } }, "additionalProperties": false }, "interviews_relationships": { "type": "object", "properties": { "stage": { "type": "object", "properties": { "data": { "description": "References to other resource objects in a to-one (\"relationship\").", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "stages", "enum": [ "stages" ] }, "id": { "type": "string", "example": "1" } } }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "interview_parts": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "interview_parts", "enum": [ "interview_parts" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "interviewable": { "type": "object", "properties": { "data": { "description": "References to other resource objects in a to-one (\"relationship\").", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "applications", "enum": [ "applications", "job_seekers" ] }, "id": { "type": "string", "example": "1" } } }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } } }, "additionalProperties": false }, "interviews_relationships_put": { "type": "object", "properties": { "stage": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/jsonapi_relationship_interviews_belongs_to_stages_put" } } }, "interview_parts": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/jsonapi_relationship_interviews_has_many_interview_parts_put" } } }, "interviewable": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/jsonapi_relationship_interviews_polymorphic_belongs_to_put" } } } }, "additionalProperties": false }, "jsonapi_relationship_interviews_belongs_to_stages_put": { "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "enum": [ "stages" ] }, "id": { "type": "string" } }, "additionalProperties": false }, "jsonapi_relationship_interviews_has_many_interview_parts_put": { "type": "array", "items": { "type": "object", "required": [ "type", "id", "temp-id", "method" ], "properties": { "type": { "type": "string", "enum": [ "interview_parts" ] }, "id": { "type": "string", "description": "Required for `update, destroy` methods" }, "temp-id": { "type": "string", "description": "Required for `create` method" }, "method": { "type": "string", "enum": [ "create", "update", "destroy" ] } }, "additionalProperties": false }, "uniqueItems": true }, "jsonapi_relationship_interviews_polymorphic_belongs_to_put": { "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "enum": [ "applications", "job_seekers" ] }, "id": { "type": "string" } }, "additionalProperties": false }, "interviews_resource": { "type": "object", "properties": { "id": { "type": "string", "example": "1" }, "type": { "type": "string", "enum": [ "interviews" ] }, "attributes": { "$ref": "#/components/schemas/interviews" }, "relationships": { "$ref": "#/components/schemas/interviews_relationships" } }, "additionalProperties": false }, "interviews_resource_put": { "type": "object", "properties": { "id": { "type": "string", "example": "1" }, "type": { "type": "string", "enum": [ "interviews" ] }, "attributes": { "$ref": "#/components/schemas/interviews_attributes_put" }, "relationships": { "$ref": "#/components/schemas/interviews_relationships_put" } }, "additionalProperties": false }, "interviews_single": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/interviews_resource" }, "included": { "description": "To reduce the number of HTTP requests, servers **MAY** allow responses that include related resources along with the requested primary resources. Such responses are called \"compound documents\".", "type": "array", "items": { "oneOf": [ { "$ref": "#/components/schemas/stages_resource" }, { "$ref": "#/components/schemas/interview_parts_resource" }, { "$ref": "#/components/schemas/applications_resource" }, { "$ref": "#/components/schemas/job_seekers_resource" } ] }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_meta" } }, "additionalProperties": false }, "interviews_request_put": { "type": "object", "properties": { "data": { "$ref": "#/components/schemas/interviews_resource_put" }, "included": { "type": "array", "items": { "type": "object", "properties": { "type": { "type": "string", "enum": [ "interview_parts" ] }, "id": { "type": "string" }, "temp-id": { "type": "string" }, "attributes": { "type": "object", "oneOf": [ { "$ref": "#/components/schemas/interview_parts_attributes_put" } ] } } } } } }, "job_seekers": { "type": "object", "description": "Job Seeker attributes", "properties": { "candidate_id": { "type": "integer", "readOnly": true }, "first_name": { "type": "string" }, "last_name": { "type": "string" }, "preferred_name": { "type": "string" }, "full_name": { "type": "string", "readOnly": true }, "email": { "type": "string" }, "phone": { "type": "string" }, "phone_iso2": { "type": "string" }, "date_of_birth": { "type": "string", "format": "date" }, "address1": { "type": "string" }, "address2": { "type": "string", "description": "Address line 2 for non-US addresses. Returns `null` for US addresses. Writing this attribute is not supported when `country` is `US`." }, "town": { "type": "string" }, "state_province": { "type": "string", "description": "State or province for US addresses. Returns `null` for non-US addresses. Writing this attribute is only supported when `country` is `US`." }, "postcode": { "type": "string" }, "country": { "type": "string" }, "summary": { "type": "string" }, "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "locale": { "type": "string" }, "external_system_reference": { "type": "string", "description": "Used to store the ID or reference from an external system that the record was created from." }, "channel": { "type": "string" }, "channel_source": { "type": "string" }, "pipeline_source": { "type": "string" }, "cv_base64_data": { "type": "string", "writeOnly": true }, "cv_base64_filename": { "type": "string", "writeOnly": true }, "add_tag_with_context": { "type": "object", "additionalProperties": true, "description": "Add a single **tag**\nExample: `{\"tag\": \"Celery\", \"context\": \"custom_green\"}`", "writeOnly": true }, "add_tags_with_context": { "type": "array", "items": {}, "description": "Add multiple **tags** at once\nExample: `[{\"tag\": \"Celery\", \"context\": \"custom_green\"}, {\"tag\": \"Availability\", \"context\": \"rejection\"}]`", "writeOnly": true }, "remove_tag_with_context": { "type": "object", "additionalProperties": true, "description": "Remove a single **tag**\nExample: `{\"tag\": \"Celery\", \"context\": \"custom_green\"}`", "writeOnly": true }, "attachments": { "type": "array", "items": { "type": "object", "properties": { "context": { "type": "string" }, "name": { "type": "string" }, "url": { "type": "string" } } }, "description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)", "readOnly": true }, "average_rating": { "type": "number", "format": "float", "description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)", "readOnly": true }, "tags": { "type": "array", "items": {}, "description": "This is an extra attribute. If you want it to be returned please add `extra_fields` query param (see Query Params section)", "readOnly": true } }, "additionalProperties": false }, "job_seekers_relationships": { "type": "object", "properties": { "answers": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "answers", "enum": [ "answers" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "candidate": { "type": "object", "properties": { "data": { "description": "References to other resource objects in a to-one (\"relationship\").", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "candidates", "enum": [ "candidates" ] }, "id": { "type": "string", "example": "1" } } }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "comments": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "comments", "enum": [ "comments" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "custom_attributes": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "custom_attributes", "enum": [ "custom_attributes" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "structured_section_responses": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "structured_section_responses", "enum": [ "structured_section_responses" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "user_scorecards": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "user_scorecards", "enum": [ "user_scorecards" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "resume": { "type": "object", "properties": { "data": { "description": "References to other resource objects in a to-one (\"relationship\").", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "resumes", "enum": [ "resumes" ] }, "id": { "type": "string", "example": "1" } } }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } } }, "additionalProperties": false }, "job_seekers_resource": { "type": "object", "properties": { "id": { "type": "string", "example": "1" }, "type": { "type": "string", "enum": [ "job_seekers" ] }, "attributes": { "$ref": "#/components/schemas/job_seekers" }, "relationships": { "$ref": "#/components/schemas/job_seekers_relationships" } }, "additionalProperties": false }, "stages": { "type": "object", "description": "Stage attributes", "properties": { "created_at": { "type": "string", "format": "date-time", "readOnly": true }, "updated_at": { "type": "string", "format": "date-time", "readOnly": true }, "name": { "type": "string", "readOnly": true }, "external_system_reference": { "type": "string", "description": "Used to store the ID or reference from an external system that the record was created from.", "readOnly": true }, "external_name": { "type": "string", "readOnly": true }, "description": { "type": "string", "readOnly": true }, "visible": { "type": "boolean", "readOnly": true }, "position": { "type": "integer", "readOnly": true }, "basic_type": { "type": "string", "readOnly": true } }, "additionalProperties": false }, "stages_relationships": { "type": "object", "properties": { "stageable": { "type": "object", "properties": { "data": { "description": "References to other resource objects in a to-one (\"relationship\").", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "jobs", "enum": [ "jobs", "hiring_workflows" ] }, "id": { "type": "string", "example": "1" } } }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } }, "applications": { "type": "object", "properties": { "data": { "description": "An array of objects each containing \"type\" and \"id\" members for to-many relationships.", "type": "array", "items": { "description": "The \"type\" and \"id\" to non-empty members.", "type": "object", "required": [ "type", "id" ], "properties": { "type": { "type": "string", "example": "applications", "enum": [ "applications" ] }, "id": { "type": "string", "example": "1" } } }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_metaResource" } } } }, "additionalProperties": false }, "stages_resource": { "type": "object", "properties": { "id": { "type": "string", "example": "1" }, "type": { "type": "string", "enum": [ "stages" ] }, "attributes": { "$ref": "#/components/schemas/stages" }, "relationships": { "$ref": "#/components/schemas/stages_relationships" } }, "additionalProperties": false }, "jsonapi_failure": { "type": "object", "required": [ "errors" ], "properties": { "errors": { "type": "array", "items": { "$ref": "#/components/schemas/jsonapi_error" }, "uniqueItems": true }, "meta": { "$ref": "#/components/schemas/jsonapi_meta" }, "jsonapi": { "$ref": "#/components/schemas/jsonapi_jsonapi" }, "links": { "$ref": "#/components/schemas/jsonapi_links" } }, "additionalProperties": false }, "jsonapi_meta": { "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", "type": "object", "additionalProperties": true }, "jsonapi_links": { "type": "object", "additionalProperties": { "$ref": "#/components/schemas/jsonapi_link" } }, "jsonapi_link": { "description": "A link **MUST** be represented as either: a string containing the link's URL or a link object.", "oneOf": [ { "description": "A string containing the link's URL.", "type": "string", "format": "uri-reference" }, { "type": "object", "required": [ "href" ], "properties": { "href": { "description": "A string containing the link's URL.", "type": "string", "format": "uri-reference" }, "meta": { "$ref": "#/components/schemas/jsonapi_meta" } } } ] }, "jsonapi_jsonapi": { "description": "An object describing the server's implementation", "type": "object", "properties": { "version": { "type": "string" }, "meta": { "$ref": "#/components/schemas/jsonapi_meta" } }, "additionalProperties": false }, "jsonapi_error": { "type": "object", "properties": { "links": { "$ref": "#/components/schemas/jsonapi_links" }, "status": { "description": "The HTTP status code applicable to this problem, expressed as a string value.", "type": "string" }, "code": { "description": "An application-specific error code, expressed as a string value.", "type": "string" }, "title": { "description": "A short, human-readable summary of the problem. It **SHOULD NOT** change from occurrence to occurrence of the problem, except for purposes of localization.", "type": "string" }, "detail": { "description": "A human-readable explanation specific to this occurrence of the problem.", "type": "string" }, "source": { "type": "object", "properties": { "pointer": { "description": "A JSON Pointer [RFC6901] to the associated entity in the request document [e.g. \"/data\" for a primary data object, or \"/data/attributes/title\" for a specific attribute].", "type": "string" }, "parameter": { "description": "A string indicating which query parameter caused the error.", "type": "string" } } }, "meta": { "$ref": "#/components/schemas/jsonapi_meta" } }, "additionalProperties": false }, "jsonapi_metaResource": { "description": "Non-standard meta-information that can not be represented as an attribute or relationship.", "type": "object", "additionalProperties": false, "properties": { "included": { "enum": [ false ] } } } }, "parameters": { "interviews_id": { "in": "path", "required": true, "schema": { "type": "string" }, "name": "id", "description": "ID of the resource" } }, "requestBodies": { "interviews_put": { "required": true, "content": { "application/vnd.api+json": { "schema": { "$ref": "#/components/schemas/interviews_request_put" }, "examples": { "basic": { "$ref": "#/components/examples/jsonapi_interviews_put" } } } } } }, "examples": { "jsonapi_interviews_single": { "value": { "data": { "id": "1", "type": "interviews", "attributes": { "start_at": "2019-01-01T00:00:00+00:00", "end_at": "2019-01-01T00:00:00+00:00", "interviewable_id": "1", "interviewable_type": "string", "created_at": "2019-01-01T00:00:00+00:00", "updated_at": "2019-01-01T00:00:00+00:00", "status": "string", "summary": "string", "presence": "string" }, "relationships": { "stage": { "data": { "type": "stages", "id": "1" } }, "interview_parts": { "data": [ { "type": "interview_parts", "id": "1" } ] }, "interviewable": { "data": { "type": "applications", "id": "1" } } } }, "included": [ { "id": "1", "type": "stages", "attributes": { "created_at": "2019-01-01T00:00:00+00:00", "updated_at": "2019-01-01T00:00:00+00:00", "name": "string", "external_system_reference": "string", "external_name": "string", "description": "string", "visible": true, "position": 0, "basic_type": "string" }, "relationships": { "stageable": { "meta": { "included": false } }, "applications": { "meta": { "included": false } } } }, { "id": "1", "type": "interview_parts", "attributes": { "created_at": "2019-01-01T00:00:00+00:00", "company_id": "1", "conferencing_join_url": "string", "conferencing_provider_name": "string", "interview_id": "1", "position": 0, "updated_at": "2019-01-01T00:00:00+00:00" }, "relationships": { "interview": { "meta": { "included": false } }, "interviewing_users": { "meta": { "included": false } } } }, { "id": "1", "type": "applications", "attributes": { "uuid": "string", "created_at": "2019-01-01T00:00:00+00:00", "updated_at": "2019-01-01T00:00:00+00:00", "candidate_id": "1", "external_system_reference": "string", "hired_at": "2019-01-01T00:00:00+00:00", "internal_candidate": true, "job_id": "1", "job_posting_id": "1", "locale": "string", "stage_id": "1", "rejected_at": "2019-01-01T00:00:00+00:00", "phone_iso2": "string", "start_on": "2025-04-30", "is_demo": true, "first_name": "string", "last_name": "string", "preferred_name": "string", "email": "string", "phone": "string", "date_of_birth": "string", "linkedin_url": "string", "summary": "string", "preferred_pronouns": "string", "channel_source": "string", "address1": "string", "address2": "string", "town": "string", "state_province": "string", "postcode": "string", "country": "string", "country_code": "string", "country_code_alpha3": "string", "country_name": "string", "full_name": "string", "national_identifier": "string", "channel": "string", "concealed": true, "ai_score": {}, "attachments": [], "average_rating": 4.33, "tags": [], "days_in_current_stage": 0 }, "relationships": { "job": { "meta": { "included": false } }, "job_posting": { "meta": { "included": false } }, "stage": { "meta": { "included": false } }, "furthest_stage": { "meta": { "included": false } }, "candidate": { "meta": { "included": false } }, "hris_reference": { "meta": { "included": false } }, "onboarding_application": { "meta": { "included": false } }, "document_requests": { "meta": { "included": false } }, "offers": { "meta": { "included": false } }, "answers": { "meta": { "included": false } }, "custom_attributes": { "meta": { "included": false } }, "structured_section_responses": { "meta": { "included": false } }, "scorecard_ratings": { "meta": { "included": false } }, "scorecard_notes": { "meta": { "included": false } }, "scorecard_answers": { "meta": { "included": false } }, "user_scorecards": { "meta": { "included": false } }, "comments": { "meta": { "included": false } }, "resume": { "meta": { "included": false } } } } ], "meta": {} } }, "jsonapi_interviews_put": { "value": { "data": { "id": "1", "type": "interviews", "attributes": { "summary": "string" }, "relationships": { "stage": { "data": { "id": "1", "type": "stages" } }, "interview_parts": { "data": [ { "type": "interview_parts", "temp-id": "temp-1", "method": "create" } ] }, "interviewable": { "data": { "id": "1", "type": "applications" } } } }, "included": [ { "type": "interview_parts", "temp-id": "temp-1", "attributes": {} } ] } } }, "links": { "get-interview-id": { "operationId": "get-interview", "parameters": { "id": "$response.body#/data/id" } }, "update-interview-id": { "operationId": "update-interview", "parameters": { "id": "$response.body#/data/id" } }, "delete-interview-id": { "operationId": "delete-interview", "parameters": { "id": "$response.body#/data/id" } } } }, "paths": { "/api/v1/interviews/{id}": { "parameters": [ { "$ref": "#/components/parameters/interviews_id" } ], "put": { "operationId": "put-interview", "summary": "Update Interview", "tags": [ "Interviews" ], "responses": { "200": { "$ref": "#/components/responses/interviews_200" }, "400": { "$ref": "#/components/responses/400" }, "401": { "$ref": "#/components/responses/401" }, "403": { "$ref": "#/components/responses/403" }, "404": { "$ref": "#/components/responses/404" }, "422": { "$ref": "#/components/responses/422" }, "429": { "$ref": "#/components/responses/429" }, "500": { "$ref": "#/components/responses/500" } }, "requestBody": { "$ref": "#/components/requestBodies/interviews_put" } } } }, "tags": [ { "name": "Interviews", "description": "Interviews operations" } ] } ````
      \ \