Hantera etiketter

Dessa endpoints uppdaterar en samtliga kontakter i perspektivet från en etikett och returnerar en sammanfattning av etiketten i fråga.

Quickstart

curl -X POST "https://api.ip1sms.com/v2/labels/{labelName}/contacts" \
-H "Authorization: Bearer API_NYCKEL" \
-H "Content-Type: application/json" \
-d '[
  "5d8b19f972c0b7514c5b0f"
  "5d8b19f972c0b7515c5b0f"
  "5d8b19f972c0b7516c5b0f"
]'

Anrop

Lägg till en etikett för flera kontakter

Denna endpoint låter dig lägga till en etikett till många kontakter samtidigt. Den tar en samling kontakt-ID:n

Endpoint: /v2/labels/{labelName}/contacts

Metod: POST

Anropsdata

TypBeskrivningObligatorisktExempel
Array En lista med kontakt-idn där etiketten ska läggas till.Ja

[
  "5d8b19f972c0b7514c5b0f"
  "5d8b19f972c0b7515c5b0f"
  "5d8b19f972c0b7516c5b0f"
]

Fält för anrop

FältnamnTypBeskrivningObligatorisktExempel
labelNameString Namnet på etiketten som ska läggas till på dina kontakter.Ja

kunder

Radera en etikett

Denna endpoint låter dig ta bort en etikett och kan ta bort den från alla kontakter som har den. Kontakterna är annars intakta.

Endpoint: /v2/labels/{labelName}

Metod: DELETE

Exempel på anrop

https://api.ip1sms.com/v2/labels/kunder

Fält för anrop

FältnamnTypBeskrivningExempel
labelNamestring Namnet på etiketten du vill radera.

kunder

Respons

Exempel på respons

{
  "labelName": "Coworker",
  "usageCount": 3
}

Fält för respons

FältnamnTypBeskrivningExempel
labelNameString Namnet på en etikett kopplad till dina kontakter.

kunder
usageCountInteger Hur många kontakter som har etiketten på sig.

3