Contacts

10 endpoints

Contact directory, groups, and sources management

GET /accounts/{accountId}/contacts

List contacts

List contacts for the specified account with cursor pagination.

Parameters

accountId string

In path • Required

Unique account identifier assigned by Riposte.

                        acct_123456789
                      

Additional parameters

cursor string

In query • Optional

limit string

In query • Optional

updated_after string

In query • Optional

updated_before string

In query • Optional

email string

In query • Optional

name string

In query • Optional

group_id string

In query • Optional

source string

In query • Optional

Returns

Default Response

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X GET "http://localhost:8080/accounts/{accountId}/contacts"
                  
              

Example response 200

No example response available.

---

POST /accounts/{accountId}/contacts

Create contact

Create a new contact for the account.

Parameters

accountId string

In path • Required

Unique account identifier assigned by Riposte.

                        acct_123456789
                      

Request body

Required • application/json

Request body (application/json)

post-/accounts/{accountId}/contacts-request-body-application/json

object<{ given_name, family_name, nickname, … }>

Field	Type	Description	Values
avatar_url Optional	string	—	—
birthday Optional	string	—	—
company Optional	string	—	—
email_addresses Required	array<object<{ email, type, primary }>>	min items 1	—
family_name Required	string	—	—
given_name Required	string	—	—
group_ids Optional	array<string>	—	—
is_favorite Optional	boolean	—	—
job_title Optional	string	—	—
last_interaction_at Optional	string	—	—
nickname Optional	string	—	—
notes Optional	string	—	—
phone_numbers Optional	array<object<{ number, type }>>	—	—
physical_addresses Optional	array<object<{ street, city, state, … }>>	—	—
provider_contact_id Optional	string	—	—
source Optional	string	—	—

Returns

Default Response

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X POST "http://localhost:8080/accounts/{accountId}/contacts" \
                  
                    2
                      -H "Content-Type: application/json"
                  
              

Example response 200

No example response available.

---

DELETE /accounts/{accountId}/contacts/{contactId}

Delete contact

Delete a contact by identifier.

Parameters

accountId string

In path • Required

contactId string

In path • Required

Returns

Default Response

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X DELETE "http://localhost:8080/accounts/{accountId}/contacts/{contactId}"
                  
              

Example response 200

No example response available.

---

GET /accounts/{accountId}/contacts/{contactId}

Get contact

Retrieve a single contact by identifier.

Parameters

accountId string

In path • Required

contactId string

In path • Required

Returns

Default Response

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X GET "http://localhost:8080/accounts/{accountId}/contacts/{contactId}"
                  
              

Example response 200

No example response available.

---

PATCH /accounts/{accountId}/contacts/{contactId}

Update contact

Update a contact with partial changes.

Parameters

accountId string

In path • Required

contactId string

In path • Required

Request body

Optional • application/json

Request body (application/json)

patch-/accounts/{accountId}/contacts/{contactId}-request-body-application/json

object<{ given_name, family_name, nickname, … }>

Field	Type	Description	Values
avatar_url Optional	string	—	—
birthday Optional	string	—	—
company Optional	string	—	—
email_addresses Optional	array<object<{ email, type, primary }>>	—	—
family_name Optional	string	—	—
given_name Optional	string	—	—
group_ids Optional	array<string>	—	—
is_favorite Optional	boolean	—	—
job_title Optional	string	—	—
last_interaction_at Optional	string	—	—
nickname Optional	string	—	—
notes Optional	string	—	—
phone_numbers Optional	array<object<{ number, type }>>	—	—
physical_addresses Optional	array<object<{ street, city, state, … }>>	—	—
provider_contact_id Optional	string	—	—
source Optional	string	—	—

Returns

Default Response

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X PATCH "http://localhost:8080/accounts/{accountId}/contacts/{contactId}" \
                  
                    2
                      -H "Content-Type: application/json"
                  
              

Example response 200

No example response available.

---

GET /accounts/{accountId}/contacts/groups

List contact groups

List contact groups for the account.

Parameters

accountId string

In path • Required

Unique account identifier assigned by Riposte.

                        acct_123456789
                      

Returns

Default Response

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X GET "http://localhost:8080/accounts/{accountId}/contacts/groups"
                  
              

Example response 200

No example response available.

---

POST /accounts/{accountId}/contacts/groups

Create contact group

Create a new contact group.

Parameters

accountId string

In path • Required

Unique account identifier assigned by Riposte.

                        acct_123456789
                      

Request body

Required • application/json

Request body (application/json)

post-/accounts/{accountId}/contacts/groups-request-body-application/json

object<{ name, description }>

Field	Type	Description	Values
description Optional	string	—	—
name Required	string	—	—

Returns

Default Response

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X POST "http://localhost:8080/accounts/{accountId}/contacts/groups" \
                  
                    2
                      -H "Content-Type: application/json"
                  
              

Example response 200

No example response available.

---

DELETE /accounts/{accountId}/contacts/groups/{groupId}

Delete contact group

Delete a contact group.

Parameters

accountId string

In path • Required

groupId string

In path • Required

Returns

Default Response

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X DELETE "http://localhost:8080/accounts/{accountId}/contacts/groups/{groupId}"
                  
              

Example response 200

No example response available.

---

PATCH /accounts/{accountId}/contacts/groups/{groupId}

Update contact group

Update a contact group with partial fields.

Parameters

accountId string

In path • Required

groupId string

In path • Required

Request body

Optional • application/json

Request body (application/json)

patch-/accounts/{accountId}/contacts/groups/{groupId}-request-body-application/json

object<{ name, description }>

Field	Type	Description	Values
description Optional	string	—	—
name Optional	string	—	—

Returns

Default Response

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X PATCH "http://localhost:8080/accounts/{accountId}/contacts/groups/{groupId}" \
                  
                    2
                      -H "Content-Type: application/json"
                  
              

Example response 200

No example response available.

---

GET /accounts/{accountId}/contacts/sources

List contact sources

List available contact sources for the account.

Parameters

accountId string

In path • Required

Unique account identifier assigned by Riposte.

                        acct_123456789
                      

Returns

Default Response

Status: 200

Example request Copy Copied! Copy failed

cURL

                
                    1
                    curl -X GET "http://localhost:8080/accounts/{accountId}/contacts/sources"
                  
              

Example response 200

No example response available.