Ctrlk
Help CenterContact Support
For the complete documentation index, see llms.txt. This page is also available as Markdown.

Contacts

List All Contacts

get

Returns a list of your contacts for a specific campaign, with optional filtering.

Authorizations
AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters
AccountSIDstringRequired
CampaignIdintegerRequired
Query parameters
AccountIdstringOptional

Filter by a contact's partner account ID.

TitlestringOptional

Filter by a contact's title (must be URL-encoded).

Responses
200

A paginated list of contact objects.

application/json
get/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts
cURL
curl -L \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'
200

A paginated list of contact objects.

{
  "Contacts": [
    {
      "Id": "2750",
      "FirstName": "Wile",
      "LastName": "Coyote",
      "EmailAddress": "wile.coyote@example.com",
      "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 associated with one or more partner accounts. Use multipart/form-data for profile image uploads.

Authorizations
AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters
AccountSIDstringRequired
CampaignIdintegerRequired
Body
FirstNamestringRequiredExample: Wile
LastNamestringRequiredExample: Coyote
EmailAddressstring · emailRequiredExample: wile.coyote@example.com
AccountsstringRequired

A comma-separated string of partner account IDs.

Example: 12345,67890
TitlestringOptionalExample: Marketing Manager
ProfileImageUrlstring · uriOptional

URL of an image file. Cannot be used with ProfileImageFile.

Example: https://example.com/profile.jpg
ProfileImageFilestring · binaryOptional

An image file to upload. Use multipart/form-data.

WorkPhoneNumberstringOptional

Requires WorkPhoneNumberCountry.

Example: 8051234567
WorkPhoneNumberCountrystringOptionalExample: US
CellphoneNumberstringOptional

Requires CellphoneNumberCountry.

Example: 8059876543
CellphoneNumberCountrystringOptionalExample: US
LabelsstringOptional

A comma-separated string of labels.

Example: VIP,Tier1
Responses
200

The contact was created successfully.

application/json
StatusstringOptionalExample: OK
Uristring · uri-referenceOptionalExample: /Advertisers/<AccountSID>/Campaigns/1000/Contacts/2750
post/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts
cURL
curl -L \
  --request POST \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Accept: */*'
200

The contact was created successfully.

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

Get Contact Details

get

Retrieves the details of an existing contact by their unique impact.com Contact ID.

Authorizations
AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters
AccountSIDstringRequired
CampaignIdintegerRequired
ContactIdstringRequired

The unique identifier for the contact (e.g., '2750' or 'M1369520').

Responses
200

A single contact object.

application/json
IdstringOptional

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

Example: 2750
FirstNamestringOptionalExample: Wile
LastNamestringOptionalExample: Coyote
EmailAddressstring · emailOptionalExample: wile.coyote@example.com
Titlestring · nullableOptional
ProfileImagestring · uri-referenceOptionalExample: /Advertisers/<AccountSID>/Campaigns/1000/Contacts/2750/ProfileImage
WorkPhoneNumberCountrystringOptionalExample: US
WorkPhoneNumberstringOptionalExample: 8051234567
CellphoneNumberCountrystringOptionalExample: US
CellphoneNumberstringOptionalExample: 8059876543
EditablebooleanOptional

Indicates if the contact is user-created and fully editable (true) or system-created and partially editable (false).

Example: false
Labelsstring[]Optional
Uristring · uri-referenceOptionalExample: /Advertisers/<AccountSID>/Campaigns/1000/Contacts/2750
get/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts/{ContactId}
cURL
curl -L \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts/{ContactId}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'
200

A single contact object.

{
  "Id": "2750",
  "FirstName": "Wile",
  "LastName": "Coyote",
  "EmailAddress": "wile.coyote@example.com",
  "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.

  • User-created contacts ("Editable": "true") can have any parameter updated.

  • System-created contacts ("Editable": "false") can only have Title and Labels updated.

Authorizations
AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters
AccountSIDstringRequired
CampaignIdintegerRequired
ContactIdstringRequired
Body
FirstNamestringOptionalExample: Wile
LastNamestringOptionalExample: Coyote
EmailAddressstring · emailOptionalExample: wile.coyote@example.com
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

A comma-separated string of labels to add.

Example: VIP
LabelsRemovestringOptional

A comma-separated string of labels to remove.

Example: Tier2
AccountsAddstringOptional

A comma-separated string of partner account IDs to add.

Example: 12345
AccountsRemovestringOptional

A comma-separated string of partner account IDs to remove.

Example: 67890
Responses
200

The contact was updated successfully.

application/json
StatusstringOptionalExample: OK
Uristring · uri-referenceOptionalExample: /Advertisers/<AccountSID>/Campaigns/1000/Contacts/2750
put/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts/{ContactId}
cURL
curl -L \
  --request PUT \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts/{ContactId}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Content-Type: application/x-www-form-urlencoded' \
  --header 'Accept: */*'
200

The contact was updated successfully.

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

Delete a Contact

delete

Permanently deletes a user-created contact. This cannot be undone.

Authorizations
AuthorizationstringRequired

Use your AccountSID as the username and AuthToken as the password.

Path parameters
AccountSIDstringRequired
CampaignIdintegerRequired
ContactIdstringRequired
Responses
200

The contact was deleted successfully.

application/json
StatusstringOptionalExample: DELETED
delete/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts/{ContactId}
cURL
curl -L \
  --request DELETE \
  --url 'https://api.impact.com/Advertisers/{AccountSID}/Campaigns/{CampaignId}/Contacts/{ContactId}' \
  --user '{AccountSID}:{AuthToken}' \
  --header 'Accept: */*'
200

The contact was deleted successfully.

{
  "Status": "DELETED"
}
PreviousContactsNextModels

Last updated