REI Software

REI Software Help Library

Search for any help questions or topics.

Contact API

O
Orlando
Updated 3 years ago

Contact

Contact create or update.

 

Contact Appointment

 

GET/v1/contacts/:contactId/appointments/

https://rest.reisoftware.com/v1/contacts/:contactId/appointments/

Get contact appointments. 

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

contactId

sx6wyHhbFdRXh302LLNR

(Required) Contact Id

 

 

Successful response

Example Request

curl --location --request GET 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/appointments/' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

{}

Contact Tag

 

POST/v1/contacts/:contactId/tags/

https://rest.reisoftware.com/v1/contacts/:contactId/tags/

Add Tags on contacts.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

PATH VARIABLES

contactId

sx6wyHhbFdRXh302LLNR

(Required) Contact Id

BODYraw

{

    "tags": [

        "dolore cillum",

        "ex proident cillum sed sint"

    ]

}

 

 

Successful response

Example Request

curl --location --request POST 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/tags/' \

--header 'Authorization: Bearer <token>' \

--data-raw '{

    "tags": [

        "n",

        "in dolore esse dol"

    ]

}'

Example Response

200 OK

BodyHeader(1)

{

  "tags": [

    "velit exer",

    "sed ad"

  ]

}

DEL/v1/contacts/:contactId/tags/

https://rest.reisoftware.com/v1/contacts/:contactId/tags/

Delete tags from the contact.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

PATH VARIABLES

contactId

sx6wyHhbFdRXh302LLNR

(Required) Contact Id

BODYraw

{

    "tags": [

        "n",

        "in dolore esse dol"

    ]

}

 

 

Successful response

Example Request

curl --location --request DELETE 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/tags/' \

--header 'Authorization: Bearer <token>' \

--data-raw '{

    "tags": [

        "n",

        "in dolore esse dol"

    ]

}'

Example Response

200 OK

BodyHeader(1)

{

  "tags": [

    "consequat",

    "culpa ut"

  ]

}

Contact Campaign

 

POST/v1/contacts/:contactId/campaigns/:campaignId

https://rest.reisoftware.com/v1/contacts/:contactId/campaigns/:campaignId

Add contact to campaign.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

contactId

sx6wyHhbFdRXh302LLNR

(Required) Contact Id

campaignId

Y2I9XM7aO1hncuSOlc9L

(Required) Campaign Id

 

 

Successful response

Example Request

curl --location --request POST 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/campaigns/Y2I9XM7aO1hncuSOlc9L' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

""

DEL/v1/contacts/:contactId/campaigns/:campaignId

https://rest.reisoftware.com/v1/contacts/:contactId/campaigns/:campaignId

Remove contact from campaign.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

contactId

sx6wyHhbFdRXh302LLNR

(Required) Contact Id

campaignId

Y2I9XM7aO1hncuSOlc9L

(Required) Campaign Id

 

 

Successful response

Example Request

curl --location --request DELETE 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/campaigns/Y2I9XM7aO1hncuSOlc9L' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

""

DEL/v1/contacts/:contactId/campaigns/remove-all

https://rest.reisoftware.com/v1/contacts/:contactId/campaigns/remove-all

Remove contact from every campaign.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

contactId

sx6wyHhbFdRXh302LLNR

(Required) Contact Id

 

 

Successful response

Example Request

curl --location --request DELETE 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/campaigns/remove-all' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

""

Contact Workflow

 

POST/v1/contacts/:contactId/workflow/:workflowId

https://rest.reisoftware.com/v1/contacts/:contactId/workflow/:workflowId

Add contact to the workflow.



Adding contact into workflow will allow these fields.

View More

Fields

Types

Example

eventStartTime

string(datetime with timezone offset).

2021-06-23T03:30:00+01:00



Note:

This request will add contact in queue to be added in workflow. This will not get to be added realtime.

 

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

PATH VARIABLES

contactId

sx6wyHhbFdRXh302LLNR

(Required) Contact Id

workflowId

78559bb3-b920-461e-b010-7b2a2816d2a9

(Required) Workflow Id

BODYraw

{

    "eventStartTime": "2021-05-26T11:33:49.000Z"

}

 

 

Successful response

Example Request

curl --location --request POST 'https://rest.reisoftware.com/v1/contacts/sx6wyHhbFdRXh302LLNR/workflow/78559bb3-b920-461e-b010-7b2a2816d2a9' \

--header 'Authorization: Bearer <token>' \

--data-raw '{

    "eventStartTime": "2021-05-26T11:33:49.000Z"

}'

Example Response

200 OK

BodyHeader(1)

""

GET/v1/contacts/

https://rest.reisoftware.com/v1/contacts/?startAfterId=UIaE1WjAwWKdlyD7osQI&startAfter=1603870249758&limit=20&query=John




Get Contacts.

Filters:

View More

Fields

Description

query

It will search on these fields: Name, Phone, Email, Tags, and Company Name.



Sorting:

Fields

Allowed Options

Default value

sortBy

date_added or date_updated

date_added

order

asc or desc

desc



Pagination:

We will by default return the first matched 20 contacts. You can fetched next and more by passing the page on the query params (deprecated). You can see page info and total records count on to the meta

 

New: You can fetched next and more by passing the startAfter and startAfterId on the query params. You can see startAfterId and startAfter fields found into the response meta field.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

PARAMS

startAfterId

UIaE1WjAwWKdlyD7osQI

Start After Id

startAfter

1603870249758

Start After

limit

20

Limit Per Page records count. will allow maximum up to 100 and default will be 20

query

John

Contact Query

 

 

Successful response

Example Request

curl --location --request GET 'https://rest.reisoftware.com/v1/contacts/?startAfterId=UIaE1WjAwWKdlyD7osQI&startAfter=1603870249758&limit=20&query=John' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

View More

{

  "contacts": [

    {

      "id": "ocQHyuzHvysMo5N5VsXc",

      "locationId": "C2QujeCh8ZnC7al2InWR",

      "email": "JohnDeo@gmail.com",

      "emailLowerCase": "johndeo@gmail.com",

      "fingerprint": "91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24",

      "timezone": "Asia/Calcutta",

      "country": "DE",

      "source": "xyz form",

POST/v1/contacts/

https://rest.reisoftware.com/v1/contacts/



Create a contact.

Create contact will allow this fields. ex:

View More

Fields

Types

Example

firstName

string

John

lastName

string

Deo

name

string

John Deo

email

string

johndeo@gmail.com

phone

string

+1 888-888-8888

address1

long

Tonkawa Trail W

city

string

Austin

state

string

Texas

postalCode

string

45001

website

string(url)

https://www.google.com

timezone

string

America/Chihuahua

dnd

boolean

true

tags

array

["tag1", "tag2"]

customField

object

{"3r6dEOnsApNaKIhnFM6u": "Value 1", "MgobCB14YMVKuE4Ka8p1": "Value 2"}. Notes: 3r6dEOnsApNaKIhnFM6u and MgobCB14YMVKuE4Ka8p1 is a custom field id. You can find it using *Custom Fields* endpoints.

source

string

Public API




Validation:

Email or Phone are required to create contact

 

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

BODYraw

View More

{

    "email": "john@deo.com",

    "phone": "+18887324197",

    "firstName": "John",

    "lastName": "Deo",

    "name": "John Deo",

    "dateOfBirth": "1990-09-25",

    "address1": "3535 1st St N",

    "city": "Dolomite",

    "state": "AL",

    "country": "US",

 

 

Successful response

Example Request

View More

curl --location --request POST 'https://rest.reisoftware.com/v1/contacts/' \

--header 'Authorization: Bearer <token>' \

--data-raw '{

    "email": "john@deo.com",

    "phone": "+18887324197",

    "firstName": "John",

    "lastName": "Deo",

    "name": "John Deo",

    "dateOfBirth": "1990-09-25",

    "address1": "3535 1st St N",

    "city": "Dolomite",

Example Response

200 OK

BodyHeader(1)

View More

{

  "contact": {

    "id": "ocQHyuzHvysMo5N5VsXc",

    "locationId": "C2QujeCh8ZnC7al2InWR",

    "email": "JohnDeo@gmail.com",

    "emailLowerCase": "johndeo@gmail.com",

    "fingerprint": "91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24",

    "timezone": "Asia/Calcutta",

    "country": "DE",

    "source": "xyz form",

    "dateAdded": "2020-10-29T09:31:30.255Z",

GET/v1/contacts/lookup

https://rest.reisoftware.com/v1/contacts/lookup?email=john@deo.com&phone=+491971259866

Search contact by email or phone number.

If you will pass email or phone, it will try find and give contacts based on that.

OR If you will pass both first it will try to find contact with email first and if it is not able to find contact then it will try to find the match based on the phone.

Authorization:

Provide your location api key (Bearer Token).  

Validation:

Email or Phone are required to lookup contact.

AUTHORIZATION Bearer Token

Token

<token>

PARAMS

email

john@deo.com

(Required) Contact email

phone

+491971259866

(Required) Contact phone

 

 

Successful response

Example Request

curl --location --request GET 'https://rest.reisoftware.com/v1/contacts/lookup?email=john@deo.com&phone=+491971259866' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

View More

{

  "contacts": [

    {

      "id": "ocQHyuzHvysMo5N5VsXc",

      "locationId": "C2QujeCh8ZnC7al2InWR",

      "email": "JohnDeo@gmail.com",

      "emailLowerCase": "johndeo@gmail.com",

      "fingerprint": "91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24",

      "timezone": "Asia/Calcutta",

      "country": "DE",

      "source": "xyz form",

GET/v1/contacts/:id

https://rest.reisoftware.com/v1/contacts/:id

Get contact by id.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

id

ocQHyuzHvysMo5N5VsXc

(Required) Contact Id

 

 

Successful response

Example Request

curl --location --request GET 'https://rest.reisoftware.com/v1/contacts/ocQHyuzHvysMo5N5VsXc' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

View More

{

  "contact": {

    "id": "ocQHyuzHvysMo5N5VsXc",

    "locationId": "C2QujeCh8ZnC7al2InWR",

    "email": "JohnDeo@gmail.com",

    "emailLowerCase": "johndeo@gmail.com",

    "fingerprint": "91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24",

    "timezone": "Asia/Calcutta",

    "country": "DE",

    "source": "xyz form",

    "dateAdded": "2020-10-29T09:31:30.255Z",

PUT/v1/contacts/:id

https://rest.reisoftware.com/v1/contacts/:id



Update a contact.

Update contact will allow this fields. ex:

View More

Fields

Types

Example

firstName

string

John

lastName

string

Deo

name

string

John Deo

email

string

johndeo@gmail.com

phone

string

+1 888-888-8888

address1

long

Tonkawa Trail W

city

string

Austin

state

string

Texas

postalCode

string

45001

website

string(url)

https://www.google.com

timezone

string

America/Chihuahua

dnd

boolean

true

tags

array

["tag1", "tag2"]

customField

object

{"3r6dEOnsApNaKIhnFM6u": "Value 1", "MgobCB14YMVKuE4Ka8p1": "Value 2"}. Notes: 3r6dEOnsApNaKIhnFM6u and MgobCB14YMVKuE4Ka8p1 is a custom field id. You can find it using *Custom Fields* endpoints.

source

string

Public API




Validation:

Email or Phone are required to update contact

 

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

HEADERS

Content-Type

application/json

PATH VARIABLES

id

ocQHyuzHvysMo5N5VsXc

(Required) Contact Id

BODYraw

View More

{

    "firstName": "John",

    "lastName": "Deo",

    "name": "John Deo",

    "email": "john@deo.com",

    "phone": "+18887324197",

    "dateOfBirth": "1990-09-25",

    "address1": "3535 1st St N",

    "city": "Dolomite",

    "state": "AL",

    "country": "US",

 

 

Successful response

Example Request

View More

curl --location --request PUT 'https://rest.reisoftware.com/v1/contacts/ocQHyuzHvysMo5N5VsXc' \

--header 'Authorization: Bearer <token>' \

--data-raw '{

    "firstName": "John",

    "lastName": "Deo",

    "name": "John Deo",

    "email": "john@deo.com",

    "phone": "+18887324197",

    "dateOfBirth": "1990-09-25",

    "address1": "3535 1st St N",

    "city": "Dolomite",

Example Response

200 OK

BodyHeader(1)

View More

{

  "contact": {

    "id": "ocQHyuzHvysMo5N5VsXc",

    "locationId": "C2QujeCh8ZnC7al2InWR",

    "email": "JohnDeo@gmail.com",

    "emailLowerCase": "johndeo@gmail.com",

    "fingerprint": "91f4f0e0-e2dd-11ea-9b16-53b2d72e8a24",

    "timezone": "Asia/Calcutta",

    "country": "DE",

    "source": "xyz form",

    "dateAdded": "2020-10-29T09:31:30.255Z",

DEL/v1/contacts/:id

https://rest.reisoftware.com/v1/contacts/:id

Delete contact by id.

Authorization:

Provide your location api key (Bearer Token).  

AUTHORIZATION Bearer Token

Token

<token>

PATH VARIABLES

id

ocQHyuzHvysMo5N5VsXc

(Required) Contact Id

 

 

Successful response

Example Request

curl --location --request DELETE 'https://rest.reisoftware.com/v1/contacts/ocQHyuzHvysMo5N5VsXc' \

--header 'Authorization: Bearer <token>'

Example Response

200 OK

BodyHeader(1)

No response body

This request doesn't return a response body



😞 😐 😃