Contacts

Get all contacts.

GEThttps://api.usepylon.com/contacts

Response

200

Body

application/json

dataarray of Contact (object)

The data payload of the response.

errorsarray of string

The list of errors, if any.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/contacts', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": [
    {
      "account": {
        "id": "text"
      },
      "email": "text",
      "id": "text",
      "name": "text",
      "portal_role": "text"
    }
  ],
  "errors": [
    "text"
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": false
  },
  "request_id": "text"
}

Create a new contact.

POSThttps://api.usepylon.com/contacts

Body

application/json

account_id*string

The account that this contact belongs to.

avatar_urlstring

The avatar URL of the contact. Must be a square .png, .jpg or .jpeg.

custom_fieldsarray of CustomFieldValue (object)

An array of custom fields to be used on this issue.

email*string

The email of the contact.

name*string

The name of the contact.

portal_rolestring

The portal role to assign to the contact. Can be one of no_access, member, or admin. If not provided uses the default portal role from the portal settings.

Response

200

Body

application/json

dataContact (object)

errorsarray of string

The list of errors, if any.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/contacts', {
    method: 'POST',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({
      "account_id": "text",
      "email": "text",
      "name": "text"
    }),
});
const data = await response.json();

Response

200

{
  "data": {
    "account": {
      "id": "text"
    },
    "email": "text",
    "id": "text",
    "name": "text",
    "portal_role": "text"
  },
  "errors": [
    "text"
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": false
  },
  "request_id": "text"
}

Get a contact by its ID.

GEThttps://api.usepylon.com/contacts/{id}

Path parameters

id*string

The ID of the contact.

Query parameters

Response

200

Body

application/json

dataContact (object)

errorsarray of string

The list of errors, if any.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/contacts/{id}', {
    method: 'GET',
    headers: {},
});
const data = await response.json();

Response

200

{
  "data": {
    "account": {
      "id": "text"
    },
    "email": "text",
    "id": "text",
    "name": "text",
    "portal_role": "text"
  },
  "errors": [
    "text"
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": false
  },
  "request_id": "text"
}

Update an existing contact.

PATCHhttps://api.usepylon.com/contacts/{id}

Path parameters

id*string

The ID of the issue to update.

Body

application/json

avatar_urlstring

The avatar URL of the contact. Must be a square .png, .jpg or .jpeg.

custom_fieldsarray of CustomFieldValue (object)

An array of custom fields to be used on this issue.

emailstring

The email of the contact.

namestring

in: body The name of the contact.

portal_rolestring

The portal role to assign to the contact. Can be one of no_access, member, or admin.

Response

200

Body

application/json

dataContact (object)

errorsarray of string

The list of errors, if any.

paginationPagination (object)

request_idstring

The request ID for tracking.

Request

JavaScriptCurlPython

const response = await fetch('https://api.usepylon.com/contacts/{id}', {
    method: 'PATCH',
    headers: {
      "Content-Type": "application/json"
    },
    body: JSON.stringify({}),
});
const data = await response.json();

Response

200

{
  "data": {
    "account": {
      "id": "text"
    },
    "email": "text",
    "id": "text",
    "name": "text",
    "portal_role": "text"
  },
  "errors": [
    "text"
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": false
  },
  "request_id": "text"
}