So you're building something awesome and you want it to talk to Upscribe? We're so incredibly honored! Here are a few endpoints you can use to interact with Upscribe.
Each call requires and api_key
param that can be found on the integrations page in the Upscribe dashboard.
Here is an example endpoint: https://upscri.be/api/contacts
List all contacts
GET https://upscri.be/api/v1/contacts?api_key=API_KEY
Example Response
[
{
id: 95,
email: '[email protected]',
first_name: 'Lightning,
last_name: 'McQueen',
company_name: 'Rusteeze',
job_title: 'Founder'
}
]
Create or update a new contact
POST https://upscri.be/api/v1/contacts
Example Payload
Here is a list of the fields accepted when creating a new Contact.
Key | Type | Description |
|
| Your Upscribe account API key. |
|
| Upscribe ID for contact (when updating) |
|
| Email address of contact (required) |
|
| Status of contact. Will default to |
|
| First name of contact |
|
| Last name of contact |
|
| Phone number of contact |
|
| Company name of contact |
|
| Job Title of contact |
|
| An array of strings that will be assign to the contact as tags. |
Example Response
{
id: 95,
email: '[email protected]',
first_name: 'Lightning,
last_name: 'McQueen',
company_name: 'Rusteeze',
job_title: 'Founder'
}
Update contact
PUT https://upscri.be/api/v1/contacts/{id}
Example Payload
Here is a list of the fields accepted when updating an existing Contact.
Key | Type | Description |
|
| Your Upscribe account API key. |
|
| Upscribe ID for contact (when updating) |
|
| Email address of contact (required) |
|
| Status of contact. Will default to |
|
| First name of contact |
|
| Last name of contact |
|
| Phone number of contact |
|
| Company name of contact |
|
| Job Title of contact |
|
| An array of strings that will be assign to the contact as tags. |
Example Response
{
id: 95,
email: '[email protected]',
first_name: 'Lightning,
last_name: 'McQueen',
company_name: 'Rusteeze',
job_title: 'Founder'
}
Delete contact
DELETE https://upscri.be/api/v1/contacts/{id}?api_key=API_KEY
Example Response
{
message: 'Contact deleted'
}
Errors
Here is a brief overview of the possible errors you may encounter.
| No API Token provided |
| Invalid API Token |
| Contact not found |
| Could not complete request |
Feature requests? Please get in touch with us. We'd love to know what you're working on and see what we can do to help!