Errors

The YSUITE External API uses standard HTTP status codes. Every response — success or error — uses the same envelope shape.

Error response format

{
  "success": false,
  "message": "No organisation assigned to user"
}

For validation errors, the response may include an errors object with field-level details:

{
  "success": false,
  "message": "The cstname field is required.",
  "errors": {
    "cstname": ["Lead name is required."]
  }
}

HTTP status codes

Handling errors in code

const res = await fetch('https://api.ysuite.org/v1/contacts', {
  headers: {
    'x-ysuite-access-key': process.env.YSUITE_ACCESS_KEY,
    'x-ysuite-secret-key': process.env.YSUITE_SECRET_KEY,
  }
});

const body = await res.json();

if (!body.success) {
  console.error(res.status, body.message);
}

Common errors