Froged Platform API Froged.com

Froged Platform

Welcome to Froged Platform API documentation. Here, you will find info about how to connect your system with Froged. This is a work in progress, so, if you need something, please, contact us vía support@froged.com

Authentication

You can use Froged Platform API using an apikey token. You can generate this in our platform. Only workspace admin can generate it. You will need add this apikey as a header in each request version: 1.0.0

apikey

Accessing Froged using an apikey

Security Scheme Type API Key
Header parameter name: apikey

Contacts

Within this section, you will be able to find all your contacts' information such as the name, city, country, sessions in your website, etc. You can modify any information or just retrieve it with the following endpoints

Get contacts

Return a paginated list of contacts. You can set sort field, sort mode and pagination settings

query Parameters
offset
number >= 0
Default: 0

Offset for contacts pagination

pageSize
number [ 1 .. 200 ]
Default: 100

Contacts pagination size

orderBy
string
Default: "userId"

Field of the contact by which it will be ordered

orderMode
string
Default: "ASC"
Enum: "ASC" "DESC"

Ordered mode (ascending or descending)

Responses

200

Contacts

get/contacts

Froged Platform API

https://api.froged.com/contacts

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "state": "OK",
  • "message": "Contacts",
  • "data":
    {
    }
}

Get contact by id

Return a contact with specified contactId

path Parameters
contactId
required
string

Froged id for the contact

Responses

200

Contact

400

Contact not found

get/contacts/{contactId}

Froged Platform API

https://api.froged.com/contacts/{contactId}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "state": "OK",
  • "message": "Contact",
  • "data":
    {
    }
}

Set contact attributes

With this endpoint you can reset contact values. You will need the unique id for each contact in your database userId or the email. Only the data you send will be established, respecting the rest of the fields that are not specified.

💡 If the contact does not exist, it will be created

Request Body schema: application/json
Any of
  • Contact.required-userId
  • Contact.required-email
userId
required
string <= 50 characters

Contact id in your database. Must be unique in contacts collection. If it is not provided, Froged will use the email as secondary key

email
string <email> <= 100 characters

Contact's email

🚨 Attention: If the userId is not provided, Froged will use the email as secondary key. We strongly recommend fill userId field to ensure data integrity

username
string <= 100 characters

Contact's nick or username

name
string <= 100 characters

Contact's name (or fullname)

firstname
string <= 50 characters

Contact's firt name

lastname
string <= 50 characters

Contact's lastname

gender
string
Default: ""
Enum: "" "male" "female"

Contact's gender

birthdate
string <= 10 characters

Contacts's birthdate

street
string <= 100 characters

Contact's address

city
string <= 100 characters

Contact's city

💡 Froged automatically collects this value from contact's IP. If you update this value, Froged will not update the data again from the IP information since it assumes that the data that you establish has priority

postalcode
string <= 10 characters

Contact's postal code or ZIP

💡 Froged automatically collects this value from contact's IP. If you update this value, Froged will not update the data again from the IP information since it assumes that the data that you establish has priority

state
string <= 100 characters

Contact's state

💡 Froged automatically collects this value from contact's IP. If you update this value, Froged will not update the data again from the IP information since it assumes that the data that you establish has priority

region
string <= 100 characters

Contact's region

💡 Froged automatically collects this value from contact's IP. If you update this value, Froged will not update the data again from the IP information since it assumes that the data that you establish has priority

country
string <= 100 characters

Contact's country

💡 Froged automatically collects this value from contact's IP. If you update this value, Froged will not update the data again from the IP information since it assumes that the data that you establish has priority

phone
string <= 15 characters

Contact's phone number

web
string <= 100 characters

Contact's website

avatar
string <= 200 characters

Contact's avatar URL

company
string <= 100 characters

Company where the contact works

title
string <= 50 characters

Contact's role in company

description
string <= 200 characters

Role in company description

notes
string

Contact info

tags
Array of objects

List of tags for the contact.

🚨Updating If you are updating the contact, you must send an array containing objects (tags) and each object must have a name attribute of an existing tag. The established tags will be added to those already in contact.

newsletter
boolean
Default: false

Is the contact subscribed to the newsletter?

utm_source
string <= 200 characters

UTM source for this contact

💡 Froged automatically collects this value from contact's URL. You can manually update this value, Froged won't update the qualified field if you just modify this (or another UTM) field

utm_medium
string <= 200 characters

UTM medium for this contact

💡 Froged automatically collects this value from contact's URL. You can manually update this value, Froged won't update the qualified field if you just modify this (or another UTM) field

utm_term
string <= 200 characters

UTM term for this contact

💡 Froged automatically collects this value from contact's URL. You can manually update this value, Froged won't update the qualified field if you just modify this (or another UTM) field

utm_content
string <= 200 characters

UTM content for this contact

💡 Froged automatically collects this value from contact's URL. You can manually update this value, Froged won't update the qualified field if you just modify this (or another UTM) field

utm_campaign
string <= 200 characters

UTM campaign for this contact

💡 Froged automatically collects this value from contact's URL. You can manually update this value, Froged won't update the qualified field if you just modify this (or another UTM) field

language
string <= 2 characters

Browser language code

💡 ISO 639-1 format: https://en.wikipedia.org/wiki/List_of_ISO_639-1_codes

browser
string <= 50 characters

Contact's browser name

💡 Froged automatically collects this value from contact's useragent (if is provided)

os
string <= 50 characters

Contact's operative system

💡 Froged automatically collects this value from contact's useragent (if is provided)

url
string <= 300 characters

Latest URL visited by contact

💡 Froged automatically fill this field when contact browse in your page

initialReferrer
string <= 300 characters

First referrer (URL) for this contact

💡 Froged automatically fill this field when contact browse in your page

referrer
string <= 300 characters

Latest referrer (URL) for this contact

💡 Froged automatically fill this field when contact browse in your page

useragent
string <= 300 characters

Browser useragent for this contact

💡 Froged automatically fill this field when contact browse in your page

pagetitle
string <= 100 characters

Latest webpage title visited for this contact

💡 Froged automatically fill this field when contact browse in your page

lat
number
Default: 0

Contact's latitude (decimal value)

lon
number
Default: 0

Contact's longitude (decimal value)

device
string
Default: ""
Enum: "" "desktop" "tablet" "mobile"

Contact's device

💡 Froged automatically collects this value from contact's useragent (if is provided). The result may vary in some specific cases

attributes
object

Custom attributes to set. This attributes must be exist in custom attributtes.

spam
boolean
Default: false

Establishes if the contact frame like SPAM our mailings

unsubscribed
boolean
Default: false

Establishes if the contact requested to stop receiving emails

bounced
boolean
Default: false

Establishes if an email sending to the contact failed. The email address may not exist or not have space in the email inbox

dropped
boolean
Default: false

It establishes if the sending of emails to this contact was avoided because it was detected that their address is not valid

banned
boolean
Default: false

Set contact as banned

bannedReason
string <= 100 characters

Describes why the contact was banned

Responses

200

Contact updated

post/contacts/set

Froged Platform API

https://api.froged.com/contacts/set

Request samples

Content type
application/json
Example
Copy
Expand all Collapse all
{
  • "userId": "user-21",
  • "email": "pablo-picasso@malaga.es",
  • "username": "pablo-picasso-1881",
  • "name": "Pablo Picasso",
  • "firstname": "Pablo",
  • "lastname": "Picasso",
  • "gender": "male",
  • "birthdate": "1881-10-25",
  • "street": "Plaza de la Merced, 15",
  • "city": "Malaga",
  • "postalcode": "29012",
  • "state": "Malaga",
  • "region": "Andalusia",
  • "country": "Spain",
  • "phone": "+34 951 92 60 10",
  • "company": "Pablo Picasso's Museum",
  • "title": "Artist",
  • "description": "Draws unique pictures",
  • "notes": "Spanish painter, sculptor, printmaker, ceramicist and theatre designer who spent most of his adult life in France. Regarded as one of the most influential artists of the 20th century, he is known for co-founding the Cubist movement, the invention of constructed sculpture,[5][6] the co-invention of collage, and for the wide variety of styles that he helped develop and explore. Among his most famous works are the proto-Cubist Les Demoiselles d'Avignon (1907), and Guernica (1937), a dramatic portrayal of the bombing of Guernica by German and Italian airforces during the Spanish Civil War\n",
  • "tags":
    [
    ],
  • "newsletter": true,
  • "utm_source": "Google Campaign",
  • "utm_medium": "Web",
  • "utm_term": "Shipping of canvases",
  • "utm_content": "First banner button",
  • "utm_campaign": "Christmas campaign",
  • "language": "es",
  • "