▪ Associate Licence

Associate Licence API allows the user to associate a resource to a licence.

Request

Endpoint

PUT /v4/account/{account_id}/licences/{licence_id}

Path Parameters

Name	Description	Type	Examples
*{account_id}	Provided identifier of the account.	string
*{licence_id}	Identifier of the licence to be associated. Value obtainable from $.results[*].id field of List Licences Response Body.	string	Rk9FHzP2K1Hzq6kuvSJQZq

Header Parameters

Name	Description	Type	Examples
*x-api-key	Provided API key {x_api_key} that allows authentication.	string
*Authorization	Provided token {jwt_bearer} that allows authorization.	string	Bearer {jwt_bearer}

Body

AssociableResource

Field	Description	Type	Examples
*resource_type	Identifier of the type of the resource to be associated.	string	poi
*id	Identifier of the resource to be associated Value obtainable from $.results.pois[*].id field of any Search API Response Body.	int	EujqFHQra7ypyuBEgyFiXw

Supported values for {resource_type}

• poi

Example

curl -X PUT 'https://api.datappeal.io/v4/account/{account_id}/licences/Wk4WBVzUJDagozPquuyw7r' \
-H 'x-api-key: {x_api_key}' \
-H 'Authorization: Bearer {jwt_bearer}' \
-H 'Content-Type: application/json' \
-d '{
        "resource_type": "poi",
        "id": "EujqFHQra7ypyuBEgyFiXw"
    }'

Response

Status

Status	Description
200	Resource has been successfully associated to the licence.
412	Specified resource and licence are not eligible for mutual association. Possible reasons are: - licence already associated - resource already associated