Skip to main content
Altcraft Docs LogoAltcraft Docs Logo
User guideDeveloper guideAdmin guide
Company siteHelp center
English
  • Русский
  • English
v75
Login
  • User API documentation
  • API interaction
  • Matching
  • Profiles
  • Databases
  • Resources
  • Segments
    • Get statistics on resource
    • Update statistics on segment
    • Add or remove profile
    • Get profile data in a static segment
    • Create segment
    • Update segment
    • Get segment information
    • Get segments list
    • Delete segment
  • Suppression lists
  • Templates and fragments
  • Campaigns
  • Mailings
  • Automation scenarios
  • Loyalty Programs
  • Promo codes
  • Goals
  • Application push notifications
  • Market
  • Analytic reports
  • SendersDev
  • External datatables queries
  • Objects
  • Miscellaneous
  • Importing the API collection in Postman
  • List of API endpoints
  • SDK
  • Segments
  • Add or remove profile
Documentation for version v75

Add or remove profile

Description​

Adds a profile to a static segment or removes a profile by ID (profile_id).

Request URL​

Method: POST

Add a profile to a segment:https://example.com/api/v1.1/profiles/segstatic/add

Remove a profile from a segment:https://example.com/api/v1.1/profiles/segstatic/remove

Request parameters​

ParameterTypeExampleRequiredDescription
tokenstring"abcdefghijklmnqrstuvwxyz"YesAPI token
formatstring"json"NoResponse data format
By default – json
segment_idint1YesStatic segment ID
db_idint1YesProfiles database ID
profile_idString"abcdefghijklmnqrstuvwxyz"YesProfile ID in the datebase
skip_triggersbooltrueNoDisables triggers and scenarios configured for events.
By default – false.

Request example​

  • JSON
  • XML
{    
"token": "abcdefghijklmnqrstuvwxyz",
"segment_id": 2,
"db_id": 8,
"profile_id": "abcdefghijklmnqrstuvwxyz",
"skip_triggers": true
}
<xml>
<token>0</token>
<segment_id>2</segment_id>
<db_id>8</db_id>
<profile_id>abcdefghijklmnqrstuvwxyz</profile_id>
<skip_triggers>true</skip_triggers>
</xml>

Response example​

  • JSON
  • XML
{
"error": 0,
"error_text": "Successful operation"
}
<xml>
<error>0</error>
<error_text>Successful operation</error_text>
</xml>

Response parameters​

ParameterTypeDescription
errorintError code
error_textstringError text
Last updated on Feb 22, 2024
Previous
Update statistics on segment
Next
Get profile data in a static segment
  • Description
  • Request URL
  • Request parameters
  • Request example
  • Response example
  • Response parameters
© 2015 - 2025 Altcraft, LLC. All rights reserved.