light-mode-image
Learn
API Reference

Participant contacts

Create participant point of contact

Create a participant point of contact

Create a new point of contact for the specified participant. A maximum of 10 contacts can exist per participant.

Analytic events

  • ECOSYSTEM_PARTICIPANT_CONTACT_CREATE_START
  • ECOSYSTEM_PARTICIPANT_CONTACT_CREATE_SUCCESS
  • ECOSYSTEM_PARTICIPANT_CONTACT_CREATE_FAIL
POST/v1/ecosystems/{ecosystemId}/participants/{participantId}/contacts

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

Request Body

fullNamestring

Full name of the point of contact.

activeboolean

Indicates whether the point of contact is active.

emailAddress?string

Email address of the point of contact.

Formatemail
primaryPhoneNumber?string

Primary phone number of the point of contact.

secondaryPhoneNumber?string

Secondary phone number of the point of contact.

curl -X POST "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/participants/a24e391a-c27f-4b6e-9805-1ee7e03f3c58/contacts" \  -H "Content-Type: application/json" \  -d '{    "fullName": "John Doe",    "active": true  }'
{
  "id": "920f2489-d953-42f2-b2dd-f37c29b818cf",
  "fullName": "John Doe",
  "active": true,
  "emailAddress": "john.doe@example.com",
  "primaryPhoneNumber": 1234567890,
  "secondaryPhoneNumber": 987654321,
  "createdBy": {
    "clientId": "f7b9ecfc-8431-470e-a1de-94b68dd92f68",
    "managementUserId": "ab16dc65-b58e-4be2-ba77-a6f35021cb2b"
  },
  "createdAt": "2025-07-01T00:00:00.000Z",
  "lastModifiedBy": {
    "clientId": "f7b9ecfc-8431-470e-a1de-94b68dd92f68",
    "managementUserId": "ab16dc65-b58e-4be2-ba77-a6f35021cb2b"
  },
  "lastModifiedAt": "2025-07-01T00:00:00.000Z"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve all participant points of contact

Retrieve all participant points of contact

Retrieve all points of contact for given participant.

Analytic events

  • ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_LIST_START
  • ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_LIST_SUCCESS
  • ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_LIST_FAIL
GET/v1/ecosystems/{ecosystemId}/participants/{participantId}/contacts

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

participantIdstring

The UUID of the participant

Formatuuid
ecosystemIdstring

The UUID of the ecosystem

Formatuuid

Query Parameters

limit?number

Range size of returned list.

Default100
Range1 <= value <= 1000
cursor?string

Starting point for the list of entries.

curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/participants/a24e391a-c27f-4b6e-9805-1ee7e03f3c58/contacts?limit=2&cursor=Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1h"
{
  "data": [
    {
      "id": "920f2489-d953-42f2-b2dd-f37c29b818cf",
      "fullName": "John Doe",
      "active": true,
      "emailAddress": "john.doe@example.com",
      "primaryPhoneNumber": 1234567890,
      "secondaryPhoneNumber": 987654321,
      "createdBy": {
        "clientId": "f7b9ecfc-8431-470e-a1de-94b68dd92f68",
        "managementUserId": "ab16dc65-b58e-4be2-ba77-a6f35021cb2b"
      },
      "createdAt": "2025-07-01T00:00:00.000Z",
      "lastModifiedBy": {
        "clientId": "f7b9ecfc-8431-470e-a1de-94b68dd92f68",
        "managementUserId": "ab16dc65-b58e-4be2-ba77-a6f35021cb2b"
      },
      "lastModifiedAt": "2025-07-01T00:00:00.000Z"
    }
  ],
  "nextCursor": "Y3JlYXRlZEF0PTIwMjAtMDgtMjVUMDY6NDY6MDkuNTEwWiZpZD1hNjZmZmVhNS04NDhlLTQzOWQtODBhNC1kZGE1NWY1M2UzNmM"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Retrieve participant point of contact

Retrieve a participant point of contact

Retrieve a specific point of contact for a given participant.

Analytic events

  • ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_START
  • ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_SUCCESS
  • ECOSYSTEM_PARTICIPANT_CONTACT_RETRIEVE_FAIL
GET/v1/ecosystems/{ecosystemId}/participants/{participantId}/contacts/{contactId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

participantIdstring

The UUID of the participant

Formatuuid
ecosystemIdstring

The UUID of the ecosystem

Formatuuid
contactIdstring

Unique identifier of the points of contact for a given participant.

Formatuuid
curl -X GET "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/participants/a24e391a-c27f-4b6e-9805-1ee7e03f3c58/contacts/920f2489-d953-42f2-b2dd-f37c29b818cf"
{
  "id": "920f2489-d953-42f2-b2dd-f37c29b818cf",
  "fullName": "John Doe",
  "active": true,
  "emailAddress": "john.doe@example.com",
  "primaryPhoneNumber": 1234567890,
  "secondaryPhoneNumber": 987654321,
  "createdBy": {
    "clientId": "f7b9ecfc-8431-470e-a1de-94b68dd92f68",
    "managementUserId": "ab16dc65-b58e-4be2-ba77-a6f35021cb2b"
  },
  "createdAt": "2025-07-01T00:00:00.000Z",
  "lastModifiedBy": {
    "clientId": "f7b9ecfc-8431-470e-a1de-94b68dd92f68",
    "managementUserId": "ab16dc65-b58e-4be2-ba77-a6f35021cb2b"
  },
  "lastModifiedAt": "2025-07-01T00:00:00.000Z"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Update participant point of contact

Update a participant point of contact

Update a specific point of contact for a given participant.

Analytic events

  • ECOSYSTEM_PARTICIPANT_CONTACT_UPDATE_START
  • ECOSYSTEM_PARTICIPANT_CONTACT_UPDATE_SUCCESS
  • ECOSYSTEM_PARTICIPANT_CONTACT_UPDATE_FAIL
PUT/v1/ecosystems/{ecosystemId}/participants/{participantId}/contacts/{contactId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

contactIdstring

Unique identifier of the points of contact for a given participant.

Formatuuid

Request Body

fullNamestring

Full name of the point of contact.

activeboolean

Indicates whether the point of contact is active.

emailAddress?string

Email address of the point of contact.

Formatemail
primaryPhoneNumber?string

Primary phone number of the point of contact.

secondaryPhoneNumber?string

Secondary phone number of the point of contact.

curl -X PUT "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/participants/a24e391a-c27f-4b6e-9805-1ee7e03f3c58/contacts/920f2489-d953-42f2-b2dd-f37c29b818cf" \  -H "Content-Type: application/json" \  -d '{    "fullName": "John Doe",    "active": true  }'
{
  "id": "920f2489-d953-42f2-b2dd-f37c29b818cf",
  "fullName": "John Doe",
  "active": true,
  "emailAddress": "john.doe@example.com",
  "primaryPhoneNumber": 1234567890,
  "secondaryPhoneNumber": 987654321,
  "createdBy": {
    "clientId": "f7b9ecfc-8431-470e-a1de-94b68dd92f68",
    "managementUserId": "ab16dc65-b58e-4be2-ba77-a6f35021cb2b"
  },
  "createdAt": "2025-07-01T00:00:00.000Z",
  "lastModifiedBy": {
    "clientId": "f7b9ecfc-8431-470e-a1de-94b68dd92f68",
    "managementUserId": "ab16dc65-b58e-4be2-ba77-a6f35021cb2b"
  },
  "lastModifiedAt": "2025-07-01T00:00:00.000Z"
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

Delete participant point of contact

Delete a participant point of contact

Delete a specific point of contact for a given participant.

Analytic events

  • ECOSYSTEM_PARTICIPANT_CONTACT_DELETE_START
  • ECOSYSTEM_PARTICIPANT_CONTACT_DELETE_SUCCESS
  • ECOSYSTEM_PARTICIPANT_CONTACT_DELETE_FAIL
DELETE/v1/ecosystems/{ecosystemId}/participants/{participantId}/contacts/{contactId}

Authorization

AuthorizationBearer <token>

In: header

Path Parameters

contactIdstring

Unique identifier of the points of contact for a given participant.

Formatuuid
curl -X DELETE "https://example.vii.au01.mattr.global/v1/ecosystems/87880d7e-a4d0-462e-8383-3f1e5e16865d/participants/a24e391a-c27f-4b6e-9805-1ee7e03f3c58/contacts/920f2489-d953-42f2-b2dd-f37c29b818cf"
Empty
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}
{
  "code": "string",
  "message": "string",
  "details": [
    {
      "value": "string",
      "msg": "Invalid value",
      "param": "id",
      "location": "body"
    }
  ]
}

How would you rate this page?

Participant assignment

Previous Page

Participant evidence

Next Page

On this page

Create participant point of contactRetrieve all participant points of contactRetrieve participant point of contactUpdate participant point of contactDelete participant point of contact