API docs
Book a demo

Content Enrichment API / Approval Links

List approval links

Page

POST /v2/project/content/listApprovals

List the calling project's approval links with their status, approver and last-opened time — the read behind an approval column in a hotel list or an approval panel on a hotel page. Pass HotelIDs to restrict the list to specific hotels, or omit it to page through every link of the project. Results are ordered by creation time then hotel id. Hotel ids that are not live members of the project are skipped and echoed in NotInProjectIDs. A link that was revoked before its hotel ever approved is excluded, from Data and from Pagination.Total alike; a link revoked after the hotel approved stays listed, carrying RevokedAt and no Token.

Example request

curl -X POST 'https://api.ygo.ai/v2/project/content/listApprovals' \
  -H "Authorization: Bearer $YGO_API_KEY" \
  -H "X-Project-ID: $YGO_PROJECT_ID" \
  -H "Content-Type: application/json" \
  -d '{
  "Limit": 100,
  "Offset": 0
}'

Authorization

Authorization: Bearer <key>

Project-scoped API key

Headers

  • X-Project-ID string (uuid) required

    Project UUID. Required for all project-scoped endpoints.

    Example
    $YGO_PROJECT_ID

Request body required

application/json object ListApprovalsRequest

Filter and page the project's approval links. An empty body lists every link of the project.

  • HotelIDs array of string (uuid)

    Restrict the list to these hotels. Optional, at most 500 entries, each a valid non-nil UUID; omit it to list every link of the project. Duplicates are collapsed.

    Example
    [
      "019d9c2e-0ef8-7458-b0fa-8bed7182eb30",
      "019d9c23-1238-7334-bf02-4c45c50e033a"
    ]
    Limits
    max items 500
  • Limit integer

    Page size. Defaults to 100 when omitted or 0, and is capped at 500.

    Default
    100
    Example
    100
    Limits
    min 0, max 500
  • Offset integer

    Number of links to skip. Defaults to 0.

    Default
    0
    Example
    0
    Limits
    min 0
Example request: Every link of the project, first page
{
  "Limit": 100,
  "Offset": 0
}
Example request: Specific hotels, one of them not in the project
{
  "HotelIDs": [
    "019d9c2e-0ef8-7458-b0fa-8bed7182eb30",
    "019d9c23-1238-7334-bf02-4c45c50e033a",
    "019e4afb-e973-764c-9bb1-a4c66175e08b"
  ]
}

Responses

200 OK

The page of approval links.

Headers

  • X-Trace-ID string

    Request trace ID for debugging (OpenTelemetry). Include this ID when contacting support about specific requests.

    Example
    abc123def456ghi789

Body

application/json object ListApprovalsResponse

List response envelope wrapping the links, plus the membership residue.

  • Data array of object ApprovalLink required

    The project's approval links, ordered by creation time then hotel id. Always present, empty when nothing matched. Links revoked before their hotel approved are not listed.

    Each item

    One hotel's approval link and its state. The same shape is returned by createApprovalLinks and rotateApprovalLink (and by revokeApprovalLink, without Token: the link is dead). Note: this listing deliberately does not carry the full Token (contract A10.1) — a roster load returns up to 500 rows, and the plaintext token is a live mailable credential. Use TokenPreview for display; createApprovalLinks and rotateApprovalLink return the full token for the single hotel they act on.

    15 fields
    • HotelID string (uuid) required

      UUID of the hotel this link belongs to.

      Example
      019d9c2e-0ef8-7458-b0fa-8bed7182eb30
    • HotelName string required

      Display name of the hotel.

      Example
      Sotavento Beach Club
    • GiataID integer

      The hotel's GIATA id. Omitted when the hotel has none.

      Example
      5721
    • MasterCode string

      The calling project's master code for this hotel. Omitted when the project has no code for it.

      Example
      FUED0009
    • TokenPreview string required

      Display form of the token: its first 8 characters followed by an ellipsis. Never enough to reconstruct the link.

      Example
      xPBOjXHo...
    • Status string required

      Approval state of this hotel's link. waiting_for_hotel on creation; any feedback moves it to feedback_received; feedback_applied is set once the feedback has been worked in; approved is never left by a later feedback submission; the one way back to waiting_for_hotel is a re-minted link (createApprovalLinks after a revoke), which keeps ApprovedAt, ApprovedTextGeneratedAt and ApprovedBy as the record of the earlier approval.

      Values
      waiting_for_hotel feedback_received feedback_applied approved
      Example
      waiting_for_hotel
    • ApprovedAt string (date-time)

      When the hotel approved (RFC3339). Present once the hotel has ever approved: it is the RECORD of that approval and survives a later revoke and a re-minted link, so it can accompany a waiting_for_hotel Status (see createApprovalLinks). Only a fresh approval replaces it.

      Example
      2026-08-25T18:19:18.860882Z
    • ApprovedTextGeneratedAt string (date-time)

      Newest generation timestamp across the texts that were approved (RFC3339). Compare it with the hotel's current texts to see whether they changed since the approval. Present once the hotel has ever approved (it survives a revoke and a re-minted link, like ApprovedAt), and omitted then if none of the approved texts carried a timestamp.

      Example
      2026-08-19T14:14:57.674681Z
    • ApprovedBy object ApprovalApprover

      Present once the hotel has ever approved: the record of who signed off, kept across a later revoke and a re-minted link (so it can accompany a waiting_for_hotel Status) and replaced only by a fresh approval. The identity is the snapshot taken at approval time and survives deletion of the contact record (approved_by is ON DELETE SET NULL; the snapshot columns are not cleared).

      3 fields
      • Name string required

        The contact's name.

        Example
        Ayşe Yılmaz
      • Email string (email)

        The contact's email address.

        Example
        ayse@sotavento.example
      • Phone string

        The contact's phone number. Omitted when the contact did not supply one.

        Example
        +34 928 000 000
    • LastOpenedAt string (date-time)

      When the approval page was last loaded (RFC3339). Omitted while the link has never been opened.

      Example
      2026-08-25T18:19:18.966928Z
    • RevokedAt string (date-time)

      When the link was revoked (RFC3339). Omitted while the link is live. A link carrying it is never returned with a Token.

      Example
      2026-08-25T18:19:19.602402Z
    • Created boolean required

      true only when this call minted the credential in Token: a brand-new link, or a fresh one for a hotel whose link had been revoked. false for a hotel that already had a live link, and always false on rotateApprovalLink, revokeApprovalLink and listApprovals.

      Example
      true
    • CreatedBy string

      Audit identity of who minted the link: a user token records the user's email; a project API key records its project-scoped identity (project:<project-uuid>). That is what is STORED; what is RETURNED is gated. The stored identity is an operator identity by construction, so in practice it carries an internal staff email — a contact route, and therefore contact PII on the same footing as ApprovedBy.Email and ApprovedBy.Phone: it is returned only to a caller presenting a user_ token, and is omitted entirely for a proj_ project token (the key is absent, not an empty string).

      Example
      editor@example.com
    • CreatedAt string (date-time) required

      When the link was minted (RFC3339).

      Example
      2026-08-25T18:19:17.522006Z
    • UpdatedAt string (date-time) required

      When the link row was last touched (RFC3339). The updated_at trigger fires on every update, so this moves on a status transition, an approval and a token rotation — and also when the hotel merely opens the page, because that stamps last_opened_at. Do not use it to detect approval-state changes.

      Example
      2026-08-25T18:19:17.522006Z
  • Pagination object Pagination required

    Pagination info for the list.

    3 fields
    • Total integer required

      Total number of links matching the request, ignoring Limit and Offset. It counts exactly the links this endpoint lists, so links revoked before their hotel approved are excluded from it too.

      Example
      2
    • Limit integer required

      Page size actually applied.

      Example
      100
    • Offset integer required

      Offset actually applied.

      Example
      0
  • NotInProjectIDs array of string (uuid)

    Requested hotel ids that are not live members of the calling project and were therefore skipped. Omitted when every requested id was a member.

    Example
    [
      "019e4afb-e973-764c-9bb1-a4c66175e08b"
    ]
Example response: Every link of the project, including one revoked after its hotel approved
{
  "Data": [
    {
      "HotelID": "019d9c23-1238-7334-bf02-4c45c50e033a",
      "HotelName": "JAZ Makadina",
      "GiataID": 16706,
      "MasterCode": "HRGD0238",
      "TokenPreview": "QxIpAvQh...",
      "Status": "waiting_for_hotel",
      "Created": false,
      "CreatedBy": "editor@example.com",
      "CreatedAt": "2026-08-25T18:19:17.522006Z",
      "UpdatedAt": "2026-08-25T18:19:17.522006Z"
    },
    {
      "HotelID": "019d9c2e-0ef8-7458-b0fa-8bed7182eb30",
      "HotelName": "Sotavento Beach Club",
      "GiataID": 5721,
      "MasterCode": "FUED0009",
      "TokenPreview": "xPBOjXHo...",
      "Status": "approved",
      "ApprovedAt": "2026-08-25T18:19:18.860882Z",
      "ApprovedTextGeneratedAt": "2026-08-19T14:14:57.674681Z",
      "ApprovedBy": {
        "Name": "Ayşe Yılmaz",
        "Email": "ayse@sotavento.example",
        "Phone": "+34 928 000 000"
      },
      "LastOpenedAt": "2026-08-25T18:19:18.966928Z",
      "Created": false,
      "CreatedBy": "editor@example.com",
      "CreatedAt": "2026-08-25T18:19:17.522006Z",
      "UpdatedAt": "2026-08-25T18:19:18.860882Z"
    },
    {
      "HotelID": "019d9c31-77a4-7c19-9d51-2f3b8ac41e77",
      "HotelName": "Rixos Premium Belek",
      "GiataID": 32118,
      "MasterCode": "AYTD0114",
      "TokenPreview": "Lm2VrXe7...",
      "Status": "approved",
      "ApprovedAt": "2026-08-25T18:19:19.104553Z",
      "ApprovedTextGeneratedAt": "2026-08-19T14:14:57.674681Z",
      "ApprovedBy": {
        "Name": "Mehmet Demir",
        "Email": "mehmet@rixos.example",
        "Phone": "+90 242 000 00 00"
      },
      "LastOpenedAt": "2026-08-25T18:19:19.010441Z",
      "RevokedAt": "2026-08-25T18:19:19.602402Z",
      "Created": false,
      "CreatedBy": "editor@example.com",
      "CreatedAt": "2026-08-25T18:19:17.884219Z",
      "UpdatedAt": "2026-08-25T18:19:19.602402Z"
    }
  ],
  "Pagination": {
    "Total": 3,
    "Limit": 100,
    "Offset": 0
  }
}
Example response: Two links, the non-member id echoed back
{
  "Data": [
    {
      "HotelID": "019d9c23-1238-7334-bf02-4c45c50e033a",
      "HotelName": "JAZ Makadina",
      "GiataID": 16706,
      "MasterCode": "HRGD0238",
      "TokenPreview": "QxIpAvQh...",
      "Status": "waiting_for_hotel",
      "Created": false,
      "CreatedBy": "editor@example.com",
      "CreatedAt": "2026-08-25T18:19:17.522006Z",
      "UpdatedAt": "2026-08-25T18:19:17.522006Z"
    },
    {
      "HotelID": "019d9c2e-0ef8-7458-b0fa-8bed7182eb30",
      "HotelName": "Sotavento Beach Club",
      "GiataID": 5721,
      "MasterCode": "FUED0009",
      "TokenPreview": "xPBOjXHo...",
      "Status": "approved",
      "ApprovedAt": "2026-08-25T18:19:18.860882Z",
      "ApprovedTextGeneratedAt": "2026-08-19T14:14:57.674681Z",
      "ApprovedBy": {
        "Name": "Ayşe Yılmaz",
        "Email": "ayse@sotavento.example",
        "Phone": "+34 928 000 000"
      },
      "LastOpenedAt": "2026-08-25T18:19:18.966928Z",
      "Created": false,
      "CreatedBy": "editor@example.com",
      "CreatedAt": "2026-08-25T18:19:17.522006Z",
      "UpdatedAt": "2026-08-25T18:19:18.860882Z"
    }
  ],
  "Pagination": {
    "Total": 2,
    "Limit": 100,
    "Offset": 0
  },
  "NotInProjectIDs": [
    "019e4afb-e973-764c-9bb1-a4c66175e08b"
  ]
}
Example response: Same call with a proj_ project token — contact PII omitted: ApprovedBy carries Name only and CreatedBy is absent

Identical request, answered for a caller presenting a proj_ project token instead of a user_ token. ApprovedBy.Email, ApprovedBy.Phone and CreatedBy are contact PII and are omitted entirely (the keys are absent, not empty strings). Everything else is unchanged.

{
  "Data": [
    {
      "HotelID": "019d9c23-1238-7334-bf02-4c45c50e033a",
      "HotelName": "JAZ Makadina",
      "GiataID": 16706,
      "MasterCode": "HRGD0238",
      "TokenPreview": "QxIpAvQh...",
      "Status": "waiting_for_hotel",
      "Created": false,
      "CreatedAt": "2026-08-25T18:19:17.522006Z",
      "UpdatedAt": "2026-08-25T18:19:17.522006Z"
    },
    {
      "HotelID": "019d9c2e-0ef8-7458-b0fa-8bed7182eb30",
      "HotelName": "Sotavento Beach Club",
      "GiataID": 5721,
      "MasterCode": "FUED0009",
      "TokenPreview": "xPBOjXHo...",
      "Status": "approved",
      "ApprovedAt": "2026-08-25T18:19:18.860882Z",
      "ApprovedTextGeneratedAt": "2026-08-19T14:14:57.674681Z",
      "ApprovedBy": {
        "Name": "Ayşe Yılmaz"
      },
      "LastOpenedAt": "2026-08-25T18:19:18.966928Z",
      "Created": false,
      "CreatedAt": "2026-08-25T18:19:17.522006Z",
      "UpdatedAt": "2026-08-25T18:19:18.860882Z"
    }
  ],
  "Pagination": {
    "Total": 2,
    "Limit": 100,
    "Offset": 0
  }
}
400 Bad Request

Bad Request - the request body or the X-Project-ID header failed validation.

Headers

  • X-Trace-ID string

    Request trace ID for debugging (OpenTelemetry). Include this ID when contacting support about specific requests.

    Example
    abc123def456ghi789

Body

application/json object ErrorResponse

Standard v2 error response wrapper.

  • Error object ErrorDetail required

    Error detail containing a machine-readable code and human-readable message.

    3 fields
    • Code string required

      Machine-readable error code for programmatic handling.

      Example
      VALIDATION_ERROR
    • Message string required

      Human-readable error message.

      Example
      Validation failed
    • Fields array of object FieldError

      Field-level validation errors. Only present for VALIDATION_ERROR responses.

      Each item

      A single field-level validation error.

      4 fields
      • Field string required

        Path of the field that failed validation, as the request sends it: a dotted path for a field inside a nested request object, a bare name for a top-level one.

        Example
        Name
      • Message string required

        Human-readable validation error message for this field.

        Example
        Name is required
      • Code string

        Machine-readable reason the field failed validation. Optional; clients should fall back to Message when it is absent or unrecognized.

        Values
        REQUIRED TOO_LONG TOO_SHORT OUT_OF_RANGE TOO_MANY INVALID_FORMAT NOT_ALLOWED CONFLICT INVALID_ENCODING INSECURE_SCHEME UNSAFE_CONTENT REQUIRED_WHEN_ENABLED
        Example
        TOO_LONG
      • Params map of string to any

        Machine-readable values the message is built from, such as limits or allowed values. Keys are PascalCase; which keys are present depends on Code. Optional.

        Example
        {
          "Max": 200
        }
Example response: X-Project-ID header missing
{
  "Error": {
    "Code": "VALIDATION_ERROR",
    "Message": "X-Project-ID header is required"
  }
}
Example response: Malformed request body
{
  "Error": {
    "Code": "VALIDATION_ERROR",
    "Message": "Invalid request body"
  }
}
Example response: Limit or Offset is negative
{
  "Error": {
    "Code": "VALIDATION_ERROR",
    "Message": "Validation failed",
    "Fields": [
      {
        "Field": "Limit",
        "Message": "Limit and Offset must not be negative"
      }
    ]
  }
}
Example response: More than 500 entries in HotelIDs
{
  "Error": {
    "Code": "VALIDATION_ERROR",
    "Message": "Validation failed",
    "Fields": [
      {
        "Field": "HotelIDs",
        "Message": "HotelIDs may contain at most 500 entries"
      }
    ]
  }
}
Example response: An entry in HotelIDs is not a valid UUID
{
  "Error": {
    "Code": "VALIDATION_ERROR",
    "Message": "Validation failed",
    "Fields": [
      {
        "Field": "HotelIDs",
        "Message": "HotelIDs must contain valid UUIDs"
      }
    ]
  }
}
401 Unauthorized

Unauthorized - Invalid or missing bearer token.

Headers

  • X-Trace-ID string

    Request trace ID for debugging (OpenTelemetry). Include this ID when contacting support about specific requests.

    Example
    abc123def456ghi789

Body

application/json object ErrorResponse

Standard v2 error response wrapper.

  • Error object ErrorDetail required

    Error detail containing a machine-readable code and human-readable message.

    3 fields
    • Code string required

      Machine-readable error code for programmatic handling.

      Example
      VALIDATION_ERROR
    • Message string required

      Human-readable error message.

      Example
      Validation failed
    • Fields array of object FieldError

      Field-level validation errors. Only present for VALIDATION_ERROR responses.

      Each item

      A single field-level validation error.

      4 fields
      • Field string required

        Path of the field that failed validation, as the request sends it: a dotted path for a field inside a nested request object, a bare name for a top-level one.

        Example
        Name
      • Message string required

        Human-readable validation error message for this field.

        Example
        Name is required
      • Code string

        Machine-readable reason the field failed validation. Optional; clients should fall back to Message when it is absent or unrecognized.

        Values
        REQUIRED TOO_LONG TOO_SHORT OUT_OF_RANGE TOO_MANY INVALID_FORMAT NOT_ALLOWED CONFLICT INVALID_ENCODING INSECURE_SCHEME UNSAFE_CONTENT REQUIRED_WHEN_ENABLED
        Example
        TOO_LONG
      • Params map of string to any

        Machine-readable values the message is built from, such as limits or allowed values. Keys are PascalCase; which keys are present depends on Code. Optional.

        Example
        {
          "Max": 200
        }
Example response: No Authorization header
{
  "Error": {
    "Code": "UNAUTHORIZED",
    "Message": "Missing bearer token"
  }
}
Example response: The bearer token is not valid
{
  "Error": {
    "Code": "UNAUTHORIZED",
    "Message": "Invalid bearer token"
  }
}
403 Forbidden

Forbidden - the caller is authenticated but may not act on this project. Also returned with code INSUFFICIENT_SCOPE when the API key does not carry the content.authoring:read permission this endpoint requires.

Headers

  • X-Trace-ID string

    Request trace ID for debugging (OpenTelemetry). Include this ID when contacting support about specific requests.

    Example
    abc123def456ghi789

Body

application/json object ErrorResponse

Standard v2 error response wrapper.

  • Error object ErrorDetail required

    Error detail containing a machine-readable code and human-readable message.

    3 fields
    • Code string required

      Machine-readable error code for programmatic handling.

      Example
      VALIDATION_ERROR
    • Message string required

      Human-readable error message.

      Example
      Validation failed
    • Fields array of object FieldError

      Field-level validation errors. Only present for VALIDATION_ERROR responses.

      Each item

      A single field-level validation error.

      4 fields
      • Field string required

        Path of the field that failed validation, as the request sends it: a dotted path for a field inside a nested request object, a bare name for a top-level one.

        Example
        Name
      • Message string required

        Human-readable validation error message for this field.

        Example
        Name is required
      • Code string

        Machine-readable reason the field failed validation. Optional; clients should fall back to Message when it is absent or unrecognized.

        Values
        REQUIRED TOO_LONG TOO_SHORT OUT_OF_RANGE TOO_MANY INVALID_FORMAT NOT_ALLOWED CONFLICT INVALID_ENCODING INSECURE_SCHEME UNSAFE_CONTENT REQUIRED_WHEN_ENABLED
        Example
        TOO_LONG
      • Params map of string to any

        Machine-readable values the message is built from, such as limits or allowed values. Keys are PascalCase; which keys are present depends on Code. Optional.

        Example
        {
          "Max": 200
        }
Example response: Missing required scope
{
  "Error": {
    "Code": "INSUFFICIENT_SCOPE",
    "Message": "token lacks scope content.authoring:read"
  }
}
Example response: The user token has no editor access to the project
{
  "Error": {
    "Code": "FORBIDDEN",
    "Message": "Access denied to project"
  }
}
Example response: The request carries no project scope
{
  "Error": {
    "Code": "FORBIDDEN",
    "Message": "Project access required"
  }
}
404 Not Found

Not Found - the project or the hotel is not reachable for this caller.

Headers

  • X-Trace-ID string

    Request trace ID for debugging (OpenTelemetry). Include this ID when contacting support about specific requests.

    Example
    abc123def456ghi789

Body

application/json object ErrorResponse

Standard v2 error response wrapper.

  • Error object ErrorDetail required

    Error detail containing a machine-readable code and human-readable message.

    3 fields
    • Code string required

      Machine-readable error code for programmatic handling.

      Example
      VALIDATION_ERROR
    • Message string required

      Human-readable error message.

      Example
      Validation failed
    • Fields array of object FieldError

      Field-level validation errors. Only present for VALIDATION_ERROR responses.

      Each item

      A single field-level validation error.

      4 fields
      • Field string required

        Path of the field that failed validation, as the request sends it: a dotted path for a field inside a nested request object, a bare name for a top-level one.

        Example
        Name
      • Message string required

        Human-readable validation error message for this field.

        Example
        Name is required
      • Code string

        Machine-readable reason the field failed validation. Optional; clients should fall back to Message when it is absent or unrecognized.

        Values
        REQUIRED TOO_LONG TOO_SHORT OUT_OF_RANGE TOO_MANY INVALID_FORMAT NOT_ALLOWED CONFLICT INVALID_ENCODING INSECURE_SCHEME UNSAFE_CONTENT REQUIRED_WHEN_ENABLED
        Example
        TOO_LONG
      • Params map of string to any

        Machine-readable values the message is built from, such as limits or allowed values. Keys are PascalCase; which keys are present depends on Code. Optional.

        Example
        {
          "Max": 200
        }
Example response: The project does not exist or was deleted (user tokens)
{
  "Error": {
    "Code": "NOT_FOUND",
    "Message": "Project not found"
  }
}
429 Too Many Requests

Too Many Requests. The response includes a Retry-After header with the number of seconds to wait before retrying.

Headers

  • X-Trace-ID string

    Request trace ID for debugging (OpenTelemetry). Include this ID when contacting support about specific requests.

    Example
    abc123def456ghi789
  • Retry-After integer

    Number of seconds to wait before retrying the request. Present on 429 responses.

    Example
    39
    Limits
    min 1

Body

application/json object ErrorResponse

Standard v2 error response wrapper.

  • Error object ErrorDetail required

    Error detail containing a machine-readable code and human-readable message.

    3 fields
    • Code string required

      Machine-readable error code for programmatic handling.

      Example
      VALIDATION_ERROR
    • Message string required

      Human-readable error message.

      Example
      Validation failed
    • Fields array of object FieldError

      Field-level validation errors. Only present for VALIDATION_ERROR responses.

      Each item

      A single field-level validation error.

      4 fields
      • Field string required

        Path of the field that failed validation, as the request sends it: a dotted path for a field inside a nested request object, a bare name for a top-level one.

        Example
        Name
      • Message string required

        Human-readable validation error message for this field.

        Example
        Name is required
      • Code string

        Machine-readable reason the field failed validation. Optional; clients should fall back to Message when it is absent or unrecognized.

        Values
        REQUIRED TOO_LONG TOO_SHORT OUT_OF_RANGE TOO_MANY INVALID_FORMAT NOT_ALLOWED CONFLICT INVALID_ENCODING INSECURE_SCHEME UNSAFE_CONTENT REQUIRED_WHEN_ENABLED
        Example
        TOO_LONG
      • Params map of string to any

        Machine-readable values the message is built from, such as limits or allowed values. Keys are PascalCase; which keys are present depends on Code. Optional.

        Example
        {
          "Max": 200
        }
Example response: Limit exceeded
{
  "Error": {
    "Code": "RATE_LIMIT_EXCEEDED",
    "Message": "Rate limit exceeded. Retry after the number of seconds in the Retry-After header."
  }
}
500 Internal Server Error

Internal Server Error - Unexpected server error. Include the X-Trace-ID header value when contacting support.

Headers

  • X-Trace-ID string

    Request trace ID for debugging (OpenTelemetry). Include this ID when contacting support about specific requests.

    Example
    abc123def456ghi789

Body

application/json object ErrorResponse

Standard v2 error response wrapper.

  • Error object ErrorDetail required

    Error detail containing a machine-readable code and human-readable message.

    3 fields
    • Code string required

      Machine-readable error code for programmatic handling.

      Example
      VALIDATION_ERROR
    • Message string required

      Human-readable error message.

      Example
      Validation failed
    • Fields array of object FieldError

      Field-level validation errors. Only present for VALIDATION_ERROR responses.

      Each item

      A single field-level validation error.

      4 fields
      • Field string required

        Path of the field that failed validation, as the request sends it: a dotted path for a field inside a nested request object, a bare name for a top-level one.

        Example
        Name
      • Message string required

        Human-readable validation error message for this field.

        Example
        Name is required
      • Code string

        Machine-readable reason the field failed validation. Optional; clients should fall back to Message when it is absent or unrecognized.

        Values
        REQUIRED TOO_LONG TOO_SHORT OUT_OF_RANGE TOO_MANY INVALID_FORMAT NOT_ALLOWED CONFLICT INVALID_ENCODING INSECURE_SCHEME UNSAFE_CONTENT REQUIRED_WHEN_ENABLED
        Example
        TOO_LONG
      • Params map of string to any

        Machine-readable values the message is built from, such as limits or allowed values. Keys are PascalCase; which keys are present depends on Code. Optional.

        Example
        {
          "Max": 200
        }
Example response: The links could not be listed
{
  "Error": {
    "Code": "INTERNAL_ERROR",
    "Message": "Failed to list approval links"
  }
}
Example response: Hotel membership could not be verified
{
  "Error": {
    "Code": "INTERNAL_ERROR",
    "Message": "Failed to verify hotels"
  }
}