From-Fields
GET /from-fields
This method returns list of all from fields that are defined for this account.
(https://app.getresponse.com/account.html#my-emails)
Returns status code
200
Request url
/from-fields?perPage=10&page=4
Request params
Field name | Field type | Field description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
query | hash | Used to search only resources that meets criteria. You can specify multiple parameters, then it uses AND logic.
| |||||||||
fields | string | List of fields that should be returned. Id is always returned. Fields should be separated by comma | |||||||||
sort | hash | Enable sorting using specified field (set as a key) and order (set as a value). You can specify multiple fields to sort by.
| |||||||||
perPage | int | Number results on page | |||||||||
page | int | Page number |
Example Response
[
{
"fromFieldId": "TTzW",
"email": "jsmith@example.com",
"name": "John Smith",
"isActive": "true",
"isDefault": "true",
"createdOn": "2013-09-26T15:17:46+0000",
"href": "http://api.getresponse.com/v3/from-fields/V"
}
]
GET /from-fields/{fromFieldId}
This method returns from field by fromfieldId.
(https://app.getresponse.com/account.html#my-emails)
Returns status code
200
Request url
/from-fields/TTzW?fields=email,name
Request params
Field name | Field type | Field description |
---|---|---|
fields | string | List of fields that should be returned. Id is always returned. Fields should be separated by comma |
Example Response
{
"fromFieldId": "TTzW",
"email": "jsmith@example.com",
"name": "John Smith",
"isActive": "true",
"isDefault": "true",
"createdOn": "2009-07-04T21:05:18+0000",
"href": "http://api.getresponse.com/v3/from-fields/V"
}
POST /from-fields
This request will create new from-field
(https://app.getresponse.com/account.html#my-emails)
Returns status code
201
Example Request Body
{
"email": "jsmith@example.com",
"name": "John Smith"
}
Body params
Field name | Field type | Field description |
---|---|---|
string | Email address | |
name | string | Name connected to email address |
Example Response
{
"fromFieldId": "V",
"email": "jsmith@example.com",
"name": "John Smith",
"isActive": "true",
"isDefault": "true",
"createdOn": "2014-09-02T09:09:16+0000",
"href": "http://api.getresponse.com/v3/from-fields/V"
}
DELETE /from-fields/{fromFieldId}
This request removes fromField. You could pass new fromFieldId in the body of this request, and we will replace it in place if the removed one.
(https://app.getresponse.com/account.html#my-emails)
Returns status code
204
Example Request Body
{
"fromFieldIdToReplaceWith": "2"
}
Body params
Field name | Field type | Field description |
---|---|---|
fromFieldIdToReplaceWith | string | Id of other from field, for all current usages of from field |
Possible Errors
POST /from-fields/{fromFieldId}/default
Returns status code
200
Example Response
{
"fromFieldId": "V",
"email": "jsmith@example.com",
"name": "John Smith",
"isActive": "true",
"isDefault": "true",
"createdOn": "2014-09-02T09:09:16+0000",
"href": "http://api.getresponse.com/v3/from-fields/V"
}