Saltar al contenido

Create an interview

Módulo Opportunities

POST/interviewsinterviews.create

An interview or audition for an application. Creates an interview. Requires `Idempotency-Key`; a replay returns the original response. The organization is derived from the credential or the parent row, never from the body.

  • Requiere la capacidad opportunities.application.review.
  • Alcances de OAuth: opportunities.
  • Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
  • Estados de error: 400, 401, 409, 422, 429. Los errores son detalles de problema RFC 9457.

Cuerpo de la solicitud: InterviewCreate

interviews.create: InterviewCreate
CampoTipoObligatorioDescripción
application_idstring (uuid)SíIdentifier of the application.
scheduled_atstring (date-time)SíWhen it is scheduled.
interview_kind"Interview" | "Audition"SíInterview or Audition.
duration_minutesintegerSíLength in minutes.Restricciones: range 1 to any
location_textstring | nullNoPlace or meeting link.Restricciones: length 1 to 2000
internal_notestring | nullNoInternal note. Never visible externally.Restricciones: length 1 to 20000
{
  "application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scheduled_at": "2026-10-08T14:30:00Z",
  "interview_kind": "Interview",
  "duration_minutes": 30,
  "location_text": "Production office, Hall B",
  "internal_note": "Strong rigging resume."
}

Respuesta 201: Interview

interviews.create: Interview
CampoTipoObligatorioDescripción
idstring (uuid)SíIdentifier of the interview.
org_idstring (uuid)SíIdentifier of the owning organization, derived from the parent row and never accepted from the caller.
created_atstring (date-time)SíWhen the row was created.
created_bystring (uuid) | nullSíIdentifier of the person who created the row; null when a seed, platform or system process created it.
updated_atstring (date-time)SíWhen the row was last updated.
updated_bystring (uuid) | nullSíIdentifier of the person who last updated the row; null when a seed, platform or system process updated it.
application_idstring (uuid)SíIdentifier of the application.
scheduled_atstring (date-time)SíWhen it is scheduled.
interview_kind"Interview" | "Audition"SíInterview or Audition.
duration_minutesintegerSíLength in minutes.Restricciones: range 1 to any
location_textstring | nullSíPlace or meeting link.Restricciones: length 1 to 2000
internal_notestring | nullSíInternal note. Never visible externally.Restricciones: length 1 to 20000
{
  "id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "org_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "created_at": "2026-10-08T14:30:00Z",
  "created_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "updated_at": "2026-10-08T14:30:00Z",
  "updated_by": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
  "scheduled_at": "2026-10-08T14:30:00Z",
  "interview_kind": "Interview",
  "duration_minutes": 30,
  "location_text": "Production office, Hall B",
  "internal_note": "Strong rigging resume."
}

Ejemplos de código

curl -X POST "$XOS_BASE_URL/interviews" \
  -H "Authorization: Bearer $XOS_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{"application_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","scheduled_at":"2026-10-08T14:30:00Z","interview_kind":"Interview","duration_minutes":30,"location_text":"Production office, Hall B","internal_note":"Strong rigging resume."}'
const { data } = await xos.interviews.create({
    "application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
    "scheduled_at": "2026-10-08T14:30:00Z",
    "interview_kind": "Interview",
    "duration_minutes": 30,
    "location_text": "Production office, Hall B",
    "internal_note": "Strong rigging resume."
  });
response = xos.interviews.create({"application_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f", "scheduled_at": "2026-10-08T14:30:00Z", "interview_kind": "Interview", "duration_minutes": 30, "location_text": "Production office, Hall B", "internal_note": "Strong rigging resume."})
xos interviews create --data '{"application_id":"0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f","scheduled_at":"2026-10-08T14:30:00Z","interview_kind":"Interview","duration_minutes":30,"location_text":"Production office, Hall B","internal_note":"Strong rigging resume."}'