API Contact Endpoints

The Contact Endpoints are used to modify Contacts within Sentori.

This endpoint is used to retrieve a Contact from your Sentori Account, either by their SystemID or EmailAddress.

All Fields that can be exported through the web interface are included in the response.

Examples:

GET https://api.sentoriapp.com/v2.0/contact/get/joe%40example.sentoriapp.com/

GET https://api.sentoriapp.com/v2.0/contact/get/16382/

For other response codes, see the Error List.

{
  "IsSuppressed" : false,
  "IsBadEmailAddress" : false,
  "SystemID" : 16382,
  "CRMID" : null,
  "Title" : "Mr",
  "FirstName" : "Joe",
  "LastName" : "Example",
  "KnownAs" : null,
  "EmailAddress" : "joe@example.sentoriapp.com",
  "CompanyName" : null,
  "PhoneNumber" : null,
  "MobilePhoneNumber" : null,
  "CreatedSourceValue" : "Uploaded",
  "CreatedIPAddress" : "127.0.0.1",
  "CreatedHttpReferrerUrl" : null,
  "CreatedTimestamp" : "2010-05-13T09:00:00",
  "ModifiedTimestamp" : "2010-05-13T09:00:00",
  "IsConfirmed" : true,
  "IsBadMobilePhoneNumber" : false
}

This endpoint is used to add a new Contact to the Sentori Account.

Note: The EmailAddress Contact Field should not appear in the Add request body, and will fail if it doesn't match the request URI.

Request body is only needed if including Contact Fields. The example below would add a new Contact with the FirstName and LastName Contact Fields being set.

{
    "FirstName":"Joe",
    "LastName":"Bloggs"
}

The complete Contact as it then exists in Sentori is returned.

See the Get a Contact endpoint's Example Response for details.

This endpoint is used to update an existing Contact's Contact Fields in the Sentori Account.
If updating the EmailAddress use the existing one in the URI (and URL encode it) and the new one in the request body.

Request body should contain the Contact Fields to update. The below example updates the email address and first/last names.

{
    "EmailAddress":"joe@example.sentoriapp.com",
    "FirstName":"Joe",
    "LastName":"Bloggs"
}

The complete Contact as it then exists in Sentori is returned.

See the Get a Contact endpoint's Example Response for details.

This endpoint can be used when you have some contact data and wish Sentori to decide whether it should perform an Add or an Update with it.

If you DON'T include an Email Address in the request's body, it behaves very simply:

• Email Address doesn't exist: a new Contact is created.
• Email Address does exist: the existing Contact is updated.

If you DO include an Email Address in the request body, it becomes more interesting. Here are some examples showing what happens when a Contact does or does not exist:

• URI's Email Address exists, body's doesn't: the existing Contact is updated and their Email Address changed.
• Neither the URI's nor the body's Email Address exists: the endpoint will create a new Contact from the body's Email Address and values.
• URI's Email Address doesn't exist, body's does: the endpoint will update the Contact that has the body's Email Address.
• The URI's and body's Email Addresses both exist (and are different): both matching Contacts are updated with the body values (apart from Email Address).

The Request body can contain Contact Fields to add or update a Contact, as appropriate. The below example includes the first and last names.

When including Email Address in the body, see the examples above for possible scenarios.

{
    "FirstName":"Joe",
    "LastName":"Bloggs"
}

For other responses, see the Error List.

For a successful result, the complete Contact as it then exists in Sentori is returned.

See the Get a Contact endpoint's Example Response for details.

In the described situation of the original Request's URI and body containing an Email Address and a Contact eixsting for both of them, the Contact with the body's Email Address is returned.

This endpoint is used to delete an existing Contact from the Sentori Account.

Leave blank.

This endpoint is used to retrieve an example structure of a Contact in your Sentori Account. This may be useful when integrating Sentori with another system that has the ability to represent this within its interface.

Only Fields that can be imported into are included in the response.

Examples:

GET https://api.sentoriapp.com/v2.0/contact/getstructure/single/

GET https://api.sentoriapp.com/v2.0/contact/getstructure/list/

For other response codes, see the Error List.

{
  "IsBadEmailAddress" : false,
  "CRMID" : "string",
  "Title" : "string",
  "FirstName" : "string",
  "LastName" : "string",
  "KnownAs" : "string",
  "EmailAddress" : "string",
  "CompanyName" : "string",
  "PhoneNumber" : "string",
  "MobilePhoneNumber" : "string",
  "IsBadMobilePhoneNumber" : false
}

[
  {
    "IsBadEmailAddress" : false,
    "CRMID" : "string",
    "Title" : "string",
    "FirstName" : "string",
    "LastName" : "string",
    "KnownAs" : "string",
    "EmailAddress" : "string",
    "CompanyName" : "string",
    "PhoneNumber" : "string",
    "MobilePhoneNumber" : "string",
    "IsBadMobilePhoneNumber" : false
  }
]

This endpoint is used to subscribe a Contact to a Mailing List.
You can find the Mailing List external IDs on the Mailing List page in Sentori.

This endpoint is used to unsubscribe a Contact from a Mailing List.
You can find the Mailing List external IDs on the Mailing List page in Sentori.

This endpoint is used to unsubscribe a Contact from all Mailing Lists and add them to the Suppression List.

If no Contact exists for the Email Address, it'll simply be added to the Account's Suppression List.

This endpoint is used to add & update many Contacts to a Sentori Account, when imported a new Upload Group will appear in the Sentori Account.

Example

{
	"TotalRows": 4,
	"EmailableRowsCreated": 1,
	"EmailableRowsUpdated": 2,
	"SuppressedUpdated": 1,
	"BadEmailUpdated": 0,
	"ExcludedDuplicates": 0,
	"ExcludedInvalidEmail": 0,
	"ExcludedRoleBased": 0,
	"UploadGroupExternalID": "1234ABCD"
}

This endpoint is used to attach an existing Upload Group to a Draft Email in preparation for sending.