User Emails
API endpoints to allow the user to manage their emails.
List emails
List emails of the currently logged in user.
GET https://seeclickfix.com/api/v2/emails
Returns a list of emails.
Required Parameters
- logged in user - The user must be logged in to view their emails.
Optional Parameters
none.
Order
The sort order is alphabetical by email.
Examples
$ curl -i https://seeclickfix.com/api/v2/emails
Returns the current user’s emails
Status: 200 OK{
"metadata": {
},
"emails": [
{
"id": 1,
"confirmed": false,
"email": "foo@bar.com"
}
],
"errors": {
}
}Add an email
Adds an email to the current user.
POST https://seeclickfix.com/api/v2/emails
Returns the email just added.
Required Parameters
- logged in user - The user must be logged in as the user to add an email to.
- email - The new email to be added.
Optional Parameters
none.
Examples
$ curl --data "email=foo@bar.com" -i https://seeclickfix.com/api/v2/emails
Returns the current user’s emails
Status: 201 Created{
"id": 1,
"confirmed": false,
"email": "foo@bar.com"
}Remove an email
Removes an email from the current user.
DELETE https://seeclickfix.com/api/v2/emails/:id
Returns the email just removed.
Required Parameters
- logged in user - The user must be logged in as the user to add an email to.
- id - The id of the email to be added.
Optional Parameters
none.
Examples
$ curl -X DELETE -i https://seeclickfix.com/api/v2/emails/1
Returns the email just deleted.
Status: 204 No Content{
"id": 1,
"confirmed": false,
"email": "foo@bar.com"
}