# Royalty Eligible

This module is not essential for your use, but with it you can list any user or external contact on your company as being eligible for your contract's royalties. This does not makes him receive anything, just helps you administer who you want to be listed when you are selecting someone to receive a royalty in any of your contracts

### Create a Royalty Eligible

{% openapi src="<https://api.pixway.io/docs-json>" path="/{companyId}/contracts/royalty-eligible/create" method="post" %}
<https://api.pixway.io/docs-json>
{% endopenapi %}

### List Royalty Eligibles for your company

{% openapi src="<https://api.pixway.io/docs-json>" path="/{companyId}/contracts/royalty-eligible" method="get" %}
<https://api.pixway.io/docs-json>
{% endopenapi %}

### Activate or deactivate a RoyaltyEligible

When you do not want a contact to be eligible for royalties anymore you can deactivate it so it does not interfere with any contracts they were already used for.

{% openapi src="<https://api.pixway.io/docs-json>" path="/{companyId}/contracts/royalty-eligible" method="patch" %}
<https://api.pixway.io/docs-json>
{% endopenapi %}

### Get a royalty eligible by id

{% openapi src="<https://api.pixway.io/docs-json>" path="/{companyId}/contracts/royalty-eligible/{id}" method="get" %}
<https://api.pixway.io/docs-json>
{% endopenapi %}


---

# Agent Instructions: Querying This Documentation

If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question.

Perform an HTTP GET request on the current page URL with the `ask` query parameter:

```
GET https://w3block.gitbook.io/w3block-eng/dev-docs/api/key-api-services/tokens/contracts/royalty-eligible.md?ask=<question>
```

The question should be specific, self-contained, and written in natural language.
The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.