Common API Errors

List of errors that occur in the Hi Marley API. Specific API guides reference this document when applicable. 

Case Not Found

Description

The CaseID is not found for your Hi Marley organization.

Possible Resolutions

• Retry API call with corrected Case ID

Example 

{
   "errors" : [
      {
         "code" : "CaseNotFound",
         "category" : "NotFound",
         "retryable" : false,
         "status" : 404,
         "detail" : "No case found for caseId f8ef3f41-83ab-4198-9db5-51c8853ee190 for your organization",
         "path" : "/case/actions/send-message",
         "method" : "POST",
         "requestId" : "0b038c0d-bb3c-419a-acd0-a38225b86076"
      }
   ]
}

 

Primary Contact not found

Description

The operator does not have a valid account in Hi Marley. 

Possible Resolutions

• Resend API request with corrected operator email or unassigned (without the primary contact object).
• Add operator account to Hi Marley via the Manage tab (admin role)

Example 

{
    "errors": [
        {
            "code": "UserNotFound",
            "category": "NotFound",
            "retryable": false,
            "status": 404,
            "detail": "User for {\"email\":\"[e-mail]\",\"role\":\"operator\"} not found",
            "path": "/case/actions/send-template-message/{template}",
            "method": "POST",
            "requestId": UUID-String
        }
    ]
}

too many cases - get case by reference ID

Case notes

Phone Number Not Found

Description

The mobile number does not have any carrier associated data, or does not exist.

Example

{
    "errors": [
        {
            "code": "PhoneNumberNotFound",
            "category": "NotFound",
            "retryable": false,
            "status": 404,
            "detail": "Unable to find carrier provided information on phone number 81545196963",
            "meta": {},
            "path": "/phone/actions/verify/{mobile}",
            "method": "GET",
            "requestId": "bbcccc41-a30e-4b2f-8848-b2a7b885d93d"
        }
    ]
}

Should Have Required Property

Description

The request is missing a required property.  

Example

{
    "errors": [
        {
            "code": "InvalidRequestBody",
            "category": "DataValidationError",
            "retryable": false,
            "status": 400,
            "detail": " should have required property 'first'",
            "meta": [
                {
                    "dataPath": "",
                    "keyword": "required",
                    "message": "should have required property 'first'",
                    "params": {
                        "missingProperty": "first"
                    }
                }
            ],
            "path": "/user/actions/create-operator",
            "method": "POST",
            "requestId": "ad73ade4-80a6-4b17-95c7-7753ec283c43"
        }
    ]
}

Group Lead Cannot Be Member 

Description

When creating a Group, the Group Lead cannot be a Member.

Example

{
"errors": [
{
"code": "GroupLeadCannotBeMember",
"category": "DataValidationError",
"retryable": false,
"status": 400,
"detail": "[e-mail] - user cannot be both a member and a lead ",
"path": "/groups",
"method": "POST",
"requestId": "bd716f38-4ee3-42a6-b24a-82242cd3e553"
}
]
}

Group Not Created

Description

Group could not be created - Please contact [e-mail].

 

Example

{
"errors": [
{
"code": "GroupNotCreated",
"category": "GenericApiError",
"retryable": false,
"status": 400,
"detail": "group could not be created- Please contact [e-mail]",
"path": "/groups",
"method": "POST",
"requestId": "70441353-339c-4da7-9b5b-b787251a202f"
}
]
}