Contacts API

13 endpoints

Contact management and lookup.

GET

Auth Required

contact.list

Endpoint

/admin/collection/{collectionId}/contacts

Parameters

collectionId

path

string

Required

limit

query

string

offset

query

string

includeDeleted

query

string

Responses

200

Success

{
  "schema": "ContactListResponse"
}

400

Bad request

401

Unauthorized

404

Not found

POST

Auth Required

contact.create

Endpoint

/admin/collection/{collectionId}/contacts

Parameters

collectionId

path

string

Required

body

body

ContactCreateRequest

Required

See ContactCreateRequest schema

GET

Auth Required

contact.lookup

Endpoint

/admin/collection/{collectionId}/contacts/lookup

Parameters

collectionId

path

string

Required

email

query

string

phone

query

string

POST

Auth Required

contact.upsert

Endpoint

/admin/collection/{collectionId}/contacts/upsert

Responses

200

Success

{
  "schema": "ContactResponse"
}

400

Bad request

401

Unauthorized

404

Not found

GET

Auth Required

contact.get

Endpoint

/admin/collection/{collectionId}/contacts/{contactId}

Parameters

collectionId

path

string

Required

contactId

path

string

Required

includeDeleted

query

string

PATCH

Auth Required

contact.update

Endpoint

/admin/collection/{collectionId}/contacts/{contactId}

DELETE

Auth Required

contact.remove

Endpoint

/admin/collection/{collectionId}/contacts/{contactId}

POST

Auth Required

contact.erase

Endpoint

/admin/collection/{collectionId}/contacts/{contactId}/erase

GET

Auth Required

contact.getUser

Endpoint

/admin/collection/{collectionId}/owner/{userId}

POST

Auth Required

contact.publicUpsert

Endpoint

/public/collection/{collectionId}/contact

GET

Auth Required

contact.publicGetMine

Endpoint

/public/collection/{collectionId}/contact/me

PATCH

Auth Required

contact.publicUpdateMine

Endpoint

/public/collection/{collectionId}/contact/me

GET

Auth Required

contact.publicGetSchema

Endpoint

/public/collection/{collectionId}/contact/schema