Contacts

Change contact role status in bulk

Set one customer, supplier or fiscal lead role to active or inactive for up to 500 contact ids, with partial success per UUID. The operation never changes the other commercial roles or user RBAC.

post/companies/{company}/contacts/bulk/status

Request

  • Base URL: https://api.factuarea.com/v1
  • URL: https://api.factuarea.com/v1/companies/{company}/contacts/bulk/status
  • Auth: one of:
    • HTTP bearer
    • API key in header X-API-Key

Path parameters

companystring uuid required

Public identifier (UUID v7) of the company. Get it from GET /v1/me (data.scope[].id).

Headers

Idempotency-Keystring required
Example:01928f10-7c0e-7c4a-9b7d-2f8a6e3c1d4b

Client-generated opaque key (up to 255 characters; UUID v7 recommended) that makes retries safe: the first response is cached and replayed for repeats without re-executing the mutation. Reusing a key with a different body returns 422 idempotency_key_reused; the values of secret fields (password, secret…) count as part of the body, so retrying with a corrected secret under the same key is a different request, never the replay of the earlier answer. See the Idempotency guide. Required on this operation: repeating it delivers an effect that cannot be taken back (an email sent, a file generated, a third-party call, a charge), so a request without this header is rejected with 422 idempotency_key_required before any business logic runs.

Factuarea-Versionstring date
Example:2026-06-01

Pin the API version (YYYY-MM-DD, Stripe-style date versioning) for this request; omit to use the key's pinned version, or the latest if none. Unsupported version → 400 unsupported_api_version; malformed → 400 parameter_invalid_format. The effective version is echoed in the Factuarea-Version response header. See the Versioning guide.

Request body

idsstring[] required
role'customer' | 'supplier' | 'lead' required
status'active' | 'inactive' required

Response

BulkPartialSuccessV1Resource

Example response

{
  "data": {
    "total": 44,
    "successful": 42,
    "failed": 2,
    "failures": [
      {
        "id": "01928f12-5678-7abc-9def-0123456789ab",
        "error_code": "resource_not_deletable",
        "error_message": "El cliente tiene facturas emitidas y no se puede eliminar."
      },
      {
        "id": "01928f12-90ab-7cde-9012-3456789abcde",
        "error_code": "resource_not_deletable",
        "error_message": "El cliente tiene presupuestos asociados y no se puede eliminar."
      }
    ]
  }
}

Changes

No recorded changes to this operation across all 1 revision of this API.