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
| Typ | Beskrivning | Obligatoriskt | Exempel |
|---|---|---|---|
Array |
En lista med kontakt-idn där etiketten ska läggas till. | Ja | |
Fält för anrop
| Fältnamn | Typ | Beskrivning | Obligatoriskt | Exempel |
|---|---|---|---|---|
| labelName | String |
Namnet på etiketten som ska läggas till på dina kontakter. | Ja | |
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ältnamn | Typ | Beskrivning | Exempel |
|---|---|---|---|
| labelName | string |
Namnet på etiketten du vill radera. | |
Respons
Exempel på respons
{
"labelName": "Coworker",
"usageCount": 3
}
Fält för respons
| Fältnamn | Typ | Beskrivning | Exempel |
|---|---|---|---|
| labelName | String |
Namnet på en etikett kopplad till dina kontakter. | |
| usageCount | Integer |
Hur många kontakter som har etiketten på sig. | |