Contacts | Pylon

Pylon

Knowledge Base Website Changelog Book a Demo Login

get

Get a contact by its ID

Authorizations

Path parameters

idstringrequired

The ID of the contact.

Query parameters

cursorstringoptional

The cursor to use for pagination.

limitinteger · int64required

The number of accounts to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.usepylon.com/contacts/{id}?limit=1' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

{
  "data": {
    "account": {
      "id": "text"
    },
    "avatar_url": "text",
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "slug": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    },
    "email": "text",
    "emails": [
      "text"
    ],
    "id": "text",
    "name": "text",
    "portal_role": "no_access"
  },
  "request_id": "text"
}

delete

Delete an existing contact

Authorizations

Path parameters

idstringrequired

The ID of the contact to delete.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request DELETE \
  --url 'https://api.usepylon.com/contacts/{id}' \
  --header 'Authorization: Bearer JWT'

200

{
  "request_id": "text"
}

get

Get all contacts

Authorizations

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --url 'https://api.usepylon.com/contacts' \
  --header 'Authorization: Bearer JWT'

200

400

404

500

{
  "data": [
    {
      "account": {
        "id": "text"
      },
      "avatar_url": "text",
      "custom_fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "slug": "text",
          "value": "text",
          "values": [
            "text"
          ]
        }
      },
      "email": "text",
      "emails": [
        "text"
      ],
      "id": "text",
      "name": "text",
      "portal_role": "no_access"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text"
}

post

Create a new contact

Authorizations

Body

account_idstringoptional

The account that this contact belongs to.

avatar_urlstringoptional

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

custom_fieldsobject[]optional

An array of custom fields to be applied to this contact.

emailstringrequired

The email of the contact.

namestringrequired

The name of the contact.

portal_rolestring · enumoptional

The portal role to assign to the contact. If not provided uses the default portal role from the portal settings.

no_access PortalRoleNoAccess
member PortalRoleMember
admin PortalRoleAdmin

Options: no_access, member, admin

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.usepylon.com/contacts' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "account_id": "text",
    "avatar_url": "text",
    "custom_fields": [
      {
        "slug": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    ],
    "email": "text",
    "name": "text",
    "portal_role": "no_access"
  }'

200

400

404

500

{
  "data": {
    "account": {
      "id": "text"
    },
    "avatar_url": "text",
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "slug": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    },
    "email": "text",
    "emails": [
      "text"
    ],
    "id": "text",
    "name": "text",
    "portal_role": "no_access"
  },
  "request_id": "text"
}

patch

Update an existing contact

Authorizations

Path parameters

idstringrequired

The ID of the contact to update.

Body

avatar_urlstringoptional

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

custom_fieldsobject[]optional

An array of custom fields to be applied to this contact.

emailstringoptional

The email of the contact.

namestringoptional

in: body

The name of the contact.

portal_rolestring · enumoptional

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

no_access PortalRoleNoAccess
member PortalRoleMember
admin PortalRoleAdmin

Options: no_access, member, admin

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request PATCH \
  --url 'https://api.usepylon.com/contacts/{id}' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "avatar_url": "text",
    "custom_fields": [
      {
        "slug": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    ],
    "email": "text",
    "name": "text",
    "portal_role": "no_access"
  }'

200

400

404

500

{
  "data": {
    "account": {
      "id": "text"
    },
    "avatar_url": "text",
    "custom_fields": {
      "ANY_ADDITIONAL_PROPERTY": {
        "slug": "text",
        "value": "text",
        "values": [
          "text"
        ]
      }
    },
    "email": "text",
    "emails": [
      "text"
    ],
    "id": "text",
    "name": "text",
    "portal_role": "no_access"
  },
  "request_id": "text"
}

Search for contacts by a given filter

post

Currently, the following fields are filterable for contacts:

id. Allowed operators: equals, in, not_in
email. Allowed operators: equals, in, not_in
custom fields (pass in the slug of the custom field)

Authorizations

Body

cursorstringoptional

The cursor to use for pagination.

filterobjectrequired

limitinteger · int64optional

The number of contacts to fetch. Defaults to 100. Must be greater than 0 and less than 1000.

Responses

application/json

cURL

JavaScript

Python

HTTP

curl -L \
  --request POST \
  --url 'https://api.usepylon.com/contacts/search' \
  --header 'Authorization: Bearer JWT' \
  --header 'Content-Type: application/json' \
  --data '{
    "cursor": "text",
    "filter": {
      "field": "text",
      "operator": "equals",
      "subfilters": [
        "[Circular Reference]"
      ],
      "value": "text",
      "values": [
        "text"
      ]
    },
    "limit": 1
  }'

200

{
  "data": [
    {
      "account": {
        "id": "text"
      },
      "avatar_url": "text",
      "custom_fields": {
        "ANY_ADDITIONAL_PROPERTY": {
          "slug": "text",
          "value": "text",
          "values": [
            "text"
          ]
        }
      },
      "email": "text",
      "emails": [
        "text"
      ],
      "id": "text",
      "name": "text",
      "portal_role": "no_access"
    }
  ],
  "pagination": {
    "cursor": "text",
    "has_next_page": true
  },
  "request_id": "text"
}

Show child attributes

Show child attributes

Search for contacts by a given filter

Show child attributes