Create a note on a contact, deal, task, activity, or account

Create a note on one record. reltype names the record type and relid its id: reltype Subscriber with the contact id in relid adds a note to a contact. The record is named in the body; POST /notes takes no path parameter. The author is always the authenticated API user. Fails with 422 when reltype is not one of the five allowed values, when no record with relid exists for that type, or when note is empty, and with 403 when the API user may not edit notes on that record type.

{
	"note": {
		"note": "This is the text of the note",
		"relid": 2,
		"reltype": "Subscriber"
	}
}
{
    "contacts": [
        {
            "cdate": "2018-08-06T16:26:04-05:00",
            "email": "[email protected]",
            "phone": "",
            "firstName": "",
            "lastName": "",
            "orgid": "0",
            "segmentio_id": "",
            "bounced_hard": "0",
            "bounced_soft": "0",
            "bounced_date": null,
            "ip": "0",
            "ua": null,
            "hash": "14d8c4418ae944c68e9dde4a975854cc",
            "socialdata_lastcheck": null,
            "email_local": "",
            "email_domain": "",
            "sentcnt": "0",
            "rating_tstamp": null,
            "gravatar": "0",
            "deleted": "0",
            "anonymized": "0",
            "adate": null,
            "udate": "2018-09-28T17:45:11-05:00",
            "edate": null,
            "deleted_at": null,
            "created_utc_timestamp": "2018-09-21 12:04:40",
            "updated_utc_timestamp": "2018-09-28 17:45:11",
            "links": {
                "bounceLogs": "https://:account.api-us1.com/api/:version/contacts/2/bounceLogs",
                "contactAutomations": "https://:account.api-us1.com/api/:version/contacts/2/contactAutomations",
                "contactData": "https://:account.api-us1.com/api/:version/contacts/2/contactData",
                "contactGoals": "https://:account.api-us1.com/api/:version/contacts/2/contactGoals",
                "contactLists": "https://:account.api-us1.com/api/:version/contacts/2/contactLists",
                "contactLogs": "https://:account.api-us1.com/api/:version/contacts/2/contactLogs",
                "contactTags": "https://:account.api-us1.com/api/:version/contacts/2/contactTags",
                "contactDeals": "https://:account.api-us1.com/api/:version/contacts/2/contactDeals",
                "deals": "https://:account.api-us1.com/api/:version/contacts/2/deals",
                "fieldValues": "https://:account.api-us1.com/api/:version/contacts/2/fieldValues",
                "geoIps": "https://:account.api-us1.com/api/:version/contacts/2/geoIps",
                "notes": "https://:account.api-us1.com/api/:version/contacts/2/notes",
                "organization": "https://:account.api-us1.com/api/:version/contacts/2/organization",
                "plusAppend": "https://:account.api-us1.com/api/:version/contacts/2/plusAppend",
                "trackingLogs": "https://:account.api-us1.com/api/:version/contacts/2/trackingLogs",
                "scoreValues": "https://:account.api-us1.com/api/:version/contacts/2/scoreValues"
            },
            "id": "2",
            "organization": null
        }
    ],
    "note": {
        "note": "This is the text of the note",
        "cdate": "2018-09-28T17:45:11-05:00",
        "mdate": "2018-09-28T17:45:11-05:00",
        "reltype": "Subscriber",
        "relid": 2,
        "userid": "1",
        "links": {
            "activities": "https://:account.api-us1.com/api/:version/notes/2/activities",
            "user": "https://:account.api-us1.com/api/:version/notes/2/user",
            "mentions": "https://:account.api-us1.com/api/:version/notes/2/mentions",
            "notes": "https://:account.api-us1.com/api/:version/notes/2/notes",
            "owner": "https://:account.api-us1.com/api/:version/notes/2/owner"
        },
        "owner": {
            "type": "contact",
            "id": 2
        },
        "id": "2",
        "user": "1"
    }
}
Body Params
note
object

The note to create.

Responses

403

The API user may not edit notes on this record type.

422

reltype is not one of Deal, Subscriber, DealTask, Activity, CustomerAccount; or no record with relid exists for that type; or note is empty.

Language
Credentials
Header
URL
LoadingLoading…
Response
Choose an example:
application/json