POST /v1/entity/claim/reseller

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/reseller

Authentication: API Key required, User ID required

Description: Claim an entity on behalf of an agent/reseller

Parameters:

 

Parameter Type Mandatory Description Example
api_key string yes the  API key of the agent/reseller
 b66qw3edr56thhg
_user_id string yes The user_id of the agent/reseller
ax34er6tt65edr
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 errors in your request",
    "data": [
        "_user_id is a required parameter"
    ]
}

version 2 as of 4 years ago by Unknown

Docs Navigation