Contacts

List Contacts

get

Returns a list of your contacts for a specific campaign.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign (program) the contacts belong to.

Query parameters

AccountIdstringOptional

Filter contacts by a specific partner account ID.

TitlestringOptional

Filter contacts by their title.

Responses

200

An array of contact objects.

application/json

get/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

An array of contact objects.

{
  "Contacts": [
    {
      "Id": "2750",
      "FirstName": "Wile",
      "LastName": "Coyote",
      "EmailAddress": "[e-mail]",
      "Title": "",
      "ProfileImage": "/Advertisers/<AccountSID>/Campaigns/1000/Contacts/2750/ProfileImage",
      "WorkPhoneNumberCountry": "US",
      "WorkPhoneNumber": "8051234567",
      "CellphoneNumberCountry": "US",
      "CellphoneNumber": "8059876543",
      "Editable": false,
      "Labels": [
        "text"
      ],
      "Accounts": [
        {
          "Id": "text",
          "Name": "text"
        }
      ],
      "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Contacts/2750"
    }
  ]
}

Create a Contact

post

Creates a new contact and associates them with partner accounts.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign (program) to create the contact in.

Body

application/x-www-form-urlencodedmultipart/form-data

FirstNamestringRequiredExample: Wile

LastNamestringRequiredExample: Coyote

EmailAddressstring · emailRequiredExample: [e-mail]

AccountsstringRequired

A comma-separated string of partner account Ids.

Example: 12345,67890

TitlestringOptionalExample: Marketing Manager

ProfileImageUrlstring · uriOptionalExample: https://example.com/profile.jpg

ProfileImageFilestring · binaryOptional

Image file to upload.

WorkPhoneNumberstringOptionalExample: 8051234567

WorkPhoneNumberCountrystringOptionalExample: US

CellphoneNumberstringOptionalExample: 8059876543

CellphoneNumberCountrystringOptionalExample: US

LabelsstringOptional

A comma-separated string of labels.

Example: VIP,Tier1

Responses

200

The contact was successfully created.

application/json

StatusstringOptionalExample: OK

UristringOptional

post/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts

HTTPcURLJavaScriptPython

POST /Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 357

"FirstName='Wile'&LastName='Coyote'&EmailAddress='[e-mail]'&Accounts='12345,67890'&Title='Marketing Manager'&ProfileImageUrl='https://example.com/profile.jpg'&ProfileImageFile='binary'&WorkPhoneNumber='8051234567'&WorkPhoneNumberCountry='US'&CellphoneNumber='8059876543'&CellphoneNumberCountry='US'&Labels='VIP,Tier1'"

application/x-www-form-urlencodedmultipart/form-data

200

The contact was successfully created.

{
  "Status": "OK",
  "Uri": "text"
}

Retrieve a Contact

get

Retrieves the details of an existing contact.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign (program) the contact belongs to.

ContactIdstringRequired

The unique impact.com ID for the contact.

Responses

200

A contact object.

application/json

IdstringOptional

Unique Contact ID. System-created contacts are prefixed with 'M'.

Example: 2750

FirstNamestringOptionalExample: Wile

LastNamestringOptionalExample: Coyote

EmailAddressstring · emailOptionalExample: [e-mail]

TitlestringOptional

ProfileImagestring · uri-referenceOptionalExample: /Advertisers/<AccountSID>/Campaigns/1000/Contacts/2750/ProfileImage

WorkPhoneNumberCountrystringOptionalExample: US

WorkPhoneNumberstringOptionalExample: 8051234567

CellphoneNumberCountrystringOptionalExample: US

CellphoneNumberstringOptionalExample: 8059876543

EditablebooleanOptionalExample: false

Labelsstring[]Optional

Uristring · uri-referenceOptionalExample: /Advertisers/<AccountSID>/Campaigns/1000/Contacts/2750

get/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts/{ContactId}

HTTPcURLJavaScriptPython

GET /Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts/{ContactId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

A contact object.

{
  "Id": "2750",
  "FirstName": "Wile",
  "LastName": "Coyote",
  "EmailAddress": "[e-mail]",
  "Title": "",
  "ProfileImage": "/Advertisers/<AccountSID>/Campaigns/1000/Contacts/2750/ProfileImage",
  "WorkPhoneNumberCountry": "US",
  "WorkPhoneNumber": "8051234567",
  "CellphoneNumberCountry": "US",
  "CellphoneNumber": "8059876543",
  "Editable": false,
  "Labels": [
    "text"
  ],
  "Accounts": [
    {
      "Id": "text",
      "Name": "text"
    }
  ],
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Contacts/2750"
}

Update a Contact

put

Updates the specified contact. Editable - false contacts can only have Labels updated.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign (program) the contact belongs to.

ContactIdstringRequired

The unique impact.com ID for the contact to update.

Body

application/x-www-form-urlencodedmultipart/form-data

FirstNamestringOptionalExample: Wile

LastNamestringOptionalExample: Coyote

EmailAddressstring · emailOptionalExample: [e-mail]

TitlestringOptionalExample: Marketing Manager

ProfileImageUrlstring · uriOptionalExample: https://example.com/profile.jpg

ProfileImageFilestring · binaryOptional

WorkPhoneNumberstringOptional

The contact's work phone number. Requires WorkPhoneNumberCountry if updated.

Example: 8051234567

WorkPhoneNumberCountrystringOptional

Two-letter ISO 3166-1 alpha-2 country code. Required when WorkPhoneNumber is updated.

Example: US

CellphoneNumberstringOptional

The contact's cellphone number. Requires CellphoneNumberCountry if updated.

Example: 8059876543

CellphoneNumberCountrystringOptional

Two-letter ISO 3166-1 alpha-2 country code. Required when CellphoneNumber is updated.

Example: US

LabelsAddstringOptional

Comma-separated labels to add.

Example: VIP

LabelsRemovestringOptional

Comma-separated labels to remove.

Example: Tier2

AccountsAddstringOptional

Comma-separated account IDs to associate.

Example: 12345

AccountsRemovestringOptional

Comma-separated account IDs to disassociate.

Example: 67890

Responses

200

The contact was successfully updated.

application/json

StatusstringOptionalExample: OK

UristringOptional

put/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts/{ContactId}

HTTPcURLJavaScriptPython

PUT /Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts/{ContactId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Content-Type: application/x-www-form-urlencoded
Accept: */*
Content-Length: 399

"FirstName='Wile'&LastName='Coyote'&EmailAddress='[e-mail]'&Title='Marketing Manager'&ProfileImageUrl='https://example.com/profile.jpg'&ProfileImageFile='binary'&WorkPhoneNumber='8051234567'&WorkPhoneNumberCountry='US'&CellphoneNumber='8059876543'&CellphoneNumberCountry='US'&LabelsAdd='VIP'&LabelsRemove='Tier2'&AccountsAdd='12345'&AccountsRemove='67890'"

application/x-www-form-urlencodedmultipart/form-data

200

The contact was successfully updated.

{
  "Status": "OK",
  "Uri": "text"
}

Delete a Contact

delete

Permanently deletes a user-created contact (Editable - true). This cannot be undone.

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

The unique identifier for the account.

CampaignIdintegerRequired

The ID of the campaign (program) the contact belongs to.

ContactIdstringRequired

The unique impact.com ID for the contact to delete.

Responses

200

The contact was successfully deleted.

application/json

StatusstringOptionalExample: DELETED

delete/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts/{ContactId}

HTTPcURLJavaScriptPython

DELETE /Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts/{ContactId} HTTP/1.1
Host: api.impact.com
Authorization: Basic username:password
Accept: */*

200

The contact was successfully deleted.

{
  "Status": "DELETED"
}