Features
Company
Resources
© 2018 — 2024
API documentation
A contact can be contacted in multiple ways. It can be a phone number, an email address, a Twitter profile, a Telegram nickname, etc... We call these a contact field.
When retrieving a contact field, we always also return some basic information about the related contact.
GET /contact/:id/contactfields
{
"data": [
{
"id": 1,
"object": "contactfield",
"data": "[email protected]",
"contact_field_type": {
"id": 1,
"object": "contactfieldtype",
"name": "Email",
"fontawesome_icon": "fa fa-envelope-open-o",
"protocol": "mailto:",
"delible": false,
"type": "email",
"account": {
"id": 1
},
"created_at": "2017-11-24T11:19:18Z",
"updated_at": "2017-11-24T11:19:18Z"
},
"account": {
"id": 1
},
"contact": {
"id": 8,
"object": "contact",
"first_name": "Jim",
"last_name": "Halpert",
"gender": "male",
"is_partial": false,
"is_dead": false,
"deceased_date": null,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "exact",
"birthdate": "1978-10-01T00:00:00Z"
}
]
},
"account": {
"id": 1
}
},
"created_at": "2017-11-24T11:19:18Z",
"updated_at": null
},
{
"id": 2,
"object": "contactfield",
"data": "18003221",
"contact_field_type": {
"id": 2,
"object": "contactfieldtype",
"name": "Phone",
"fontawesome_icon": "fa fa-volume-control-phone",
"protocol": "tel:",
"delible": false,
"type": "phone",
"account": {
"id": 1
},
"created_at": "2017-11-24T11:19:18Z",
"updated_at": "2017-11-24T11:19:18Z"
},
"account": {
"id": 1
},
"contact": {
"id": 8,
"object": "contact",
"first_name": "Jim",
"last_name": "Halpert",
"gender": "male",
"is_partial": false,
"is_dead": false,
"deceased_date": null,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "exact",
"birthdate": "1978-10-01T00:00:00Z"
}
]
},
"account": {
"id": 1
}
},
"created_at": "2017-11-24T11:19:18Z",
"updated_at": null
},
{
"id": 3,
"object": "contactfield",
"data": "https:\/\/facebook.com",
"contact_field_type": {
"id": 3,
"object": "contactfieldtype",
"name": "Facebook",
"fontawesome_icon": "fa fa-facebook-official",
"protocol": null,
"delible": true,
"type": null,
"account": {
"id": 1
},
"created_at": "2017-11-24T11:19:18Z",
"updated_at": "2017-11-24T11:19:18Z"
},
"account": {
"id": 1
},
"contact": {
"id": 8,
"object": "contact",
"first_name": "Jim",
"last_name": "Halpert",
"gender": "male",
"is_partial": false,
"is_dead": false,
"deceased_date": null,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "exact",
"birthdate": "1978-10-01T00:00:00Z"
}
]
},
"account": {
"id": 1
}
},
"created_at": "2017-11-24T11:19:18Z",
"updated_at": null
},
{
"id": 62793,
"object": "contactfield",
"data": "123456",
"contact_field_type": {
"id": 1,
"object": "contactfieldtype",
"name": "Email",
"fontawesome_icon": "fa fa-envelope-open-o",
"protocol": "mailto:",
"delible": false,
"type": "email",
"account": {
"id": 1
},
"created_at": "2017-11-24T11:19:18Z",
"updated_at": "2017-11-24T11:19:18Z"
},
"account": {
"id": 1
},
"contact": {
"id": 8,
"object": "contact",
"first_name": "Jim",
"last_name": "Halpert",
"gender": "male",
"is_partial": false,
"is_dead": false,
"deceased_date": null,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "exact",
"birthdate": "1978-10-01T00:00:00Z"
}
]
},
"account": {
"id": 1
}
},
"created_at": "2017-11-24T16:43:50Z",
"updated_at": "2017-11-24T16:43:50Z"
},
{
"id": 62794,
"object": "contactfield",
"data": "123456",
"contact_field_type": {
"id": 1,
"object": "contactfieldtype",
"name": "Email",
"fontawesome_icon": "fa fa-envelope-open-o",
"protocol": "mailto:",
"delible": false,
"type": "email",
"account": {
"id": 1
},
"created_at": "2017-11-24T11:19:18Z",
"updated_at": "2017-11-24T11:19:18Z"
},
"account": {
"id": 1
},
"contact": {
"id": 8,
"object": "contact",
"first_name": "Jim",
"last_name": "Halpert",
"gender": "male",
"is_partial": false,
"is_dead": false,
"deceased_date": null,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "exact",
"birthdate": "1978-10-01T00:00:00Z"
}
]
},
"account": {
"id": 1
}
},
"created_at": "2017-11-25T08:40:54Z",
"updated_at": "2017-11-25T08:40:54Z"
}
],
"links": {
"first": "http:\/\/monica.app\/api\/contacts\/8\/contactfields?page=1",
"last": "http:\/\/monica.app\/api\/contacts\/8\/contactfields?page=1",
"prev": null,
"next": null
},
"meta": {
"current_page": 1,
"from": 1,
"last_page": 1,
"path": "http:\/\/monica.app\/api\/contacts\/8\/contactfields",
"per_page": 10,
"to": 5,
"total": 5
}
}GET /contactfields/:id
{
"id": 1,
"object": "contactfield",
"data": "[email protected]",
"contact_field_type": {
"id": 1,
"object": "contactfieldtype",
"name": "Email",
"fontawesome_icon": "fa fa-envelope-open-o",
"protocol": "mailto:",
"delible": false,
"type": "email",
"account": {
"id": 1
},
"created_at": "2017-11-24T11:19:18Z",
"updated_at": "2017-11-24T11:19:18Z"
},
"account": {
"id": 1
},
"contact": {
"id": 8,
"object": "contact",
"first_name": "Jim",
"last_name": "Halpert",
"gender": "male",
"is_partial": false,
"is_dead": false,
"deceased_date": null,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "exact",
"birthdate": "1978-10-01T00:00:00Z"
}
]
},
"account": {
"id": 1
}
},
"created_at": "2017-11-24T11:19:18Z",
"updated_at": null
}POST /contactfields/
| Name | Type | Description |
|---|---|---|
| data | string | Required. The actual content of the contact field. Max 255 characters. |
| contact_field_type_id | integer | Required. The type of the contact field. Has to be a valid, existing contact field type ID. You can retrieve the list of all the contact field types of an account via the API. |
| contact_id | integer | Required. The ID of the contact that the content field is associated with. |
{
"contact_field_type_id": 1,
"data": "123456",
"contact_id": 8
}The API call returns a Contact Field object if the call succeeds.
{
"id": 62795,
"object": "contactfield",
"data": "123456",
"contact_field_type": {
"id": 1,
"object": "contactfieldtype",
"name": "Email",
"fontawesome_icon": "fa fa-envelope-open-o",
"protocol": "mailto:",
"delible": false,
"type": "email",
"account": {
"id": 1
},
"created_at": "2017-11-24T11:19:18Z",
"updated_at": "2017-11-24T11:19:18Z"
},
"account": {
"id": 1
},
"contact": {
"id": 8,
"object": "contact",
"first_name": "Jim",
"last_name": "Halpert",
"gender": "male",
"is_partial": false,
"is_dead": false,
"deceased_date": null,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "exact",
"birthdate": "1978-10-01T00:00:00Z"
}
]
},
"account": {
"id": 1
}
},
"created_at": "2017-11-25T08:42:36Z",
"updated_at": "2017-11-25T08:42:36Z"
}PUT /contactfields/:id
| Name | Type | Description |
|---|---|---|
| data | string | Required. The actual content of the contact field. Max 255 characters. |
| contact_field_type_id | integer | Required. The type of the contact field. Has to be a valid, existing contact field type ID. You can retrieve the list of all the contact field types of an account via the API. |
| contact_id | integer | Required. The ID of the contact that the content field is associated with. |
{
"contact_field_type_id": 1,
"data": "456778",
"contact_id": 8
}{
"id": 62795,
"object": "contactfield",
"data": "456778",
"contact_field_type": {
"id": 1,
"object": "contactfieldtype",
"name": "Email",
"fontawesome_icon": "fa fa-envelope-open-o",
"protocol": "mailto:",
"delible": false,
"type": "email",
"account": {
"id": 1
},
"created_at": "2017-11-24T11:19:18Z",
"updated_at": "2017-11-24T11:19:18Z"
},
"account": {
"id": 1
},
"contact": {
"id": 8,
"object": "contact",
"first_name": "Jim",
"last_name": "Halpert",
"gender": "male",
"is_partial": false,
"is_dead": false,
"deceased_date": null,
"information": {
"dates": [
{
"name": "birthdate",
"is_birthdate_approximate": "exact",
"birthdate": "1978-10-01T00:00:00Z"
}
]
},
"account": {
"id": 1
}
},
"created_at": "2017-11-25T08:42:36Z",
"updated_at": "2017-11-25T08:43:47Z"
}DELETE /contactfields/:id
The response sends back the id that was just deleted.
{
"deleted": true,
"id": 31
}Features
Company
Resources
© 2018 — 2024