Replace a project's inbox address
Módulo Platform
POST/project-inboxes/{id}/replaceprojectInboxes.replace
Disables the address and returns the project's new one (app.replace_project_inbox). Mail to the old address is no longer accepted. Requires `Idempotency-Key`; a replay returns the original response. A rule that refuses the request returns 422 with `refusal` and `reason`.
- Requiere la capacidad projects.settings.write.
- Alcances de OAuth: projects.
- Envía el encabezado Idempotency-Key. Una repetición con la misma clave devuelve la respuesta original.
- Estados de error: 400, 401, 404, 409, 422, 429. Los errores son detalles de problema RFC 9457.
Parámetros de ruta y de consulta
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the project inbox. |
Respuesta 200: ProjectInbox
| Campo | Tipo | Obligatorio | Descripción |
|---|---|---|---|
| id | string (uuid) | Sí | Identifier of the project inbox. |
| org_id | string (uuid) | Sí | Identifier of the owning organization, derived from the parent row and never accepted from the caller. |
| created_at | string (date-time) | Sí | When the row was created. |
| created_by | string (uuid) | null | Sí | Identifier of the person who created the row. |
| updated_at | string (date-time) | Sí | When the row was last updated. |
| updated_by | string (uuid) | null | Sí | Identifier of the person who last updated the row. |
| project_id | string (uuid) | Sí | Identifier of the project the inbox belongs to. |
| local_part | string | Sí | Part before the @ of the receiving domain: the project key and a random suffix.Restricciones: length 1 to 63 |
| disabled_at | string (date-time) | null | Sí | When the address stopped accepting mail. |
{
"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",
"project_id": "0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f",
"local_part": "nwl-0a1b2c3d4e",
"disabled_at": "2026-10-08T14:30:00Z"
}Ejemplos de código
curl -X POST "$XOS_BASE_URL/project-inboxes/0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f/replace" \
-H "Authorization: Bearer $XOS_API_KEY" \
-H "Idempotency-Key: $(uuidgen)"const { data } = await xos.projectInboxes.replace("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f");response = xos.project_inboxes.replace("0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f")xos project-inboxes replace 0192f1e2-7c3a-7b4d-9e8f-1a2b3c4d5e6f