POST /v1/entity/claim

NOTE: This method is not accessible to users on Starter Plan API keys. Please contact us if you want premium access to our service

HTTP Method: POST

Path:  /v1/entity/claim

Authentication: API Key required, User ID required

Description: Claim an entity on behalf of a user

Parameters:

 

Parameter Type Mandatory Description Example
api_key string yes the user API key b66qw3edr56thhg
_user_id string yes The user user_id ax34er6tt65edr
claimed_user_id string yes The id of the user making the claim (must be a valid user in the User collection)  w4wer445t5gpo688
entity_id string yes The entity ID being claimed 379275323781120

 

Sample Success Response:

{
    "success": true,
    "msg": "ok",
    "data": {
        "ok": true,
        "id": "379275323781120",
        "rev": "29-f8659797282cbbfffa92c20731486e38"
    }
}

 

Error Responses 

{
    "success": false,
    "msg": "There were problems claiming this entity",
    "data": [
        "Problem retrieving user information"
    ]
}

 

{
  "success": false,
  "msg": "Unable to fetch entity to update",
  "data": {}
}

version 5 as of 6 years ago by Unknown

Docs Navigation