Contacts

List all contacts

get

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

CampaignIdintegerRequired

Query parameters

AccountIdstringOptional

TitlestringOptional

Responses

200

OK

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

OK

{
  "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

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

CampaignIdintegerRequired

Body

application/x-www-form-urlencoded

FirstNamestringRequiredExample: Wile

LastNamestringRequiredExample: Coyote

EmailAddressstring · emailRequiredExample: [e-mail]

AccountsstringRequiredExample: 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

LabelsstringOptionalExample: VIP,Tier1

Responses

200

OK

application/json

StatusstringOptionalExample: OK

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

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'"

200

OK

{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Contacts/2750"
}

Retrieve a contact

get

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

CampaignIdintegerRequired

ContactIdstringRequired

Responses

200

OK

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

OK

{
  "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

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

CampaignIdintegerRequired

ContactIdstringRequired

Body

application/x-www-form-urlencoded

FirstNamestringOptionalExample: Wile

LastNamestringOptionalExample: Coyote

EmailAddressstringOptionalExample: [e-mail]

TitlestringOptionalExample: Marketing Manager

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

LabelsAddstringOptionalExample: VIP

LabelsRemovestringOptionalExample: Tier2

AccountsAddstringOptionalExample: 12345

AccountsRemovestringOptionalExample: 67890

Responses

200

OK

application/json

StatusstringOptionalExample: OK

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

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: 258

"FirstName='Wile'&LastName='Coyote'&EmailAddress='[e-mail]'&Title='Marketing Manager'&WorkPhoneNumber='8051234567'&WorkPhoneNumberCountry='US'&LabelsAdd='VIP'&LabelsRemove='Tier2'&AccountsAdd='12345'&AccountsRemove='67890'"

200

OK

{
  "Status": "OK",
  "Uri": "/Advertisers/<AccountSID>/Campaigns/1000/Contacts/2750"
}

Delete a contact

delete

Authorizations

basicAuth

AuthorizationstringRequired

Path parameters

AccountSIDstringRequired

CampaignIdintegerRequired

ContactIdstringRequired

Responses

200

OK

application/json

StatusstringOptional

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

OK

{
  "Status": "text"
}