# Add an advisory contact

POST

/projects/{projectId}/advisory-contacts

```js
const url = 'https://zkao.io/api/v1/projects/example/advisory-contacts';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"email":"example","organization":"example","tier":"EMBARGO","software":[{"owner":"example","name":"example"}],"name":"example","title":"example","notes":"example","tags":["example"]}'
};


try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```sh
curl --request POST \
  --url https://zkao.io/api/v1/projects/example/advisory-contacts \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{ "email": "example", "organization": "example", "tier": "EMBARGO", "software": [ { "owner": "example", "name": "example" } ], "name": "example", "title": "example", "notes": "example", "tags": [ "example" ] }'
```

* Production`zkao.io/api/v1/projects/{projectId}/advisory-contacts`
* Staging`staging.zkao.io/api/v1/projects/{projectId}/advisory-contacts`

Requires scope: `contacts:write`. Puts one address on the programme’s contact list.

`software` says which of the project’s repositories this contact runs, and is required. It is what every notice is matched on: a contact who runs nothing is told nothing.

The contact starts `PENDING_VERIFICATION`, and an unconfirmed address receives nothing embargoed. The confirmation mail is sent from the app, not by this call, so nothing is emailed to the address you send here.

There is no endpoint that reads the contact list back. It is other people’s work addresses and the record of who hears about a vulnerability early.

## Authorizations

* **[bearerAuth](https://docs.zkao.io/api/#bearerauth)**

## Parameters

### Path Parameters

* **projectId**

  required

  string

## Request Bodyrequired

application/json

object

* **email**

  required

  string

* **organization**

  required

  The organisation this contact speaks for.

  string

* **tier**

  required

  How early this contact is told. `EMBARGO` hears first and alone, `DOWNSTREAM` joins once a patch exists, `ANNOUNCE` learns at public disclosure.

  string

  Allowed values: EMBARGO DOWNSTREAM ANNOUNCE

* **software**

  required

  The repositories this contact runs. At least one.

  Array\<object>

  \>= 1 items

  object

  * **owner**

    required

    string

  * **name**

    required

    string

* **name**

  string | null

* **title**

  string | null

* **notes**

  string | null

* **tags**

  Array\<string>

## Responses

### 201

Created

application/json

object

* **contact**

  required

  object

  * **id**

    required

    string

  * **email**

    required

    string

  * **organization**

    required

    string

  * **tier**

    required

    string

  * **status**

    required

    `PENDING_VERIFICATION` until the contact confirms the address. An unconfirmed address receives nothing embargoed.

    string

  * **software**

    required

    The software this contact runs, which notices are matched on.

    Array\<object>

    object

    * **owner**

      required

      string

    * **name**

      required

      string

  * **createdAt**

    required

    string format: date-time

##### Examplegenerated

```json
{
  "contact": {
    "id": "example",
    "email": "example",
    "organization": "example",
    "tier": "example",
    "status": "example",
    "software": [
      {
        "owner": "example",
        "name": "example"
      }
    ],
    "createdAt": "2026-04-15T12:00:00Z"
  }
}
```

### 400

Invalid request

application/json

object

* **error**

  required

  object

  * **code**

    required

    string

    Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal

  * **message**

    required

    string

  * **minimumCredits**

    Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

    integer

##### Example

```json
{
  "error": {
    "code": "unauthorized"
  }
}
```

### 401

Missing, malformed, expired, or revoked token

application/json

object

* **error**

  required

  object

  * **code**

    required

    string

    Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal

  * **message**

    required

    string

  * **minimumCredits**

    Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

    integer

##### Example

```json
{
  "error": {
    "code": "unauthorized"
  }
}
```

### 403

The token lacks the required scope

application/json

object

* **error**

  required

  object

  * **code**

    required

    string

    Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal

  * **message**

    required

    string

  * **minimumCredits**

    Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

    integer

##### Example

```json
{
  "error": {
    "code": "unauthorized"
  }
}
```

### 404

Resource not in this token’s project or repo allowlist

application/json

object

* **error**

  required

  object

  * **code**

    required

    string

    Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal

  * **message**

    required

    string

  * **minimumCredits**

    Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

    integer

##### Example

```json
{
  "error": {
    "code": "unauthorized"
  }
}
```

### 409

That address is already on the programme’s contact list.

application/json

object

* **error**

  required

  object

  * **code**

    required

    string

    Allowed values: unauthorized forbidden not_found bad_request conflict insufficient_credits budget_below_minimum repository_initializing diff_base_required diff_base_not_allowed diff_base_invalid diff_empty rate_limited internal

  * **message**

    required

    string

  * **minimumCredits**

    Budget_below_minimum only: the least the launch could have reserved, in credits. A diff scan’s first scan of a repository also builds its overview, so its minimum is higher.

    integer

##### Example

```json
{
  "error": {
    "code": "unauthorized"
  }
}
```
