The contacts a segment matches now
https://api.app2email.com/v1/{number}/segments/{id}/contacts Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270 -
The segment's id, or its exact name.
e.g.12
Query
-
How many (1 to 200, default 50).
- cursor string
The next_cursor of the previous answer, unchanged. Leave out for the first page.
Responses
Fields
- success boolean
- request_id string
- segment object
6 fields
- id integere.g.
12 - name string
- filter object
Which contacts a segment holds. Every condition given must hold.
5 fields
- consent_marketing boolean
true: only contacts with marketing consent. false: only without.
-
Wrote to the number in the last N days.
-
Part of the name or number.
- contacts integer
How many contacts match now (in answers that counted them).
- created string (date-time)
- updated string (date-time)
- contacts object[]
12 item fields
- identity stringe.g.
61412345678 - identity_type string
phonebsuid - phone string
- name string
- source string
- consent object
- last_inbound_at string (date-time)
- last_outbound_at string (date-time)
- created string (date-time)
- updated string (date-time)
- next_cursor string
- count integer
- total integer
Errors
- 400 The request is malformed (missing or invalid fields, query parameters or times).
- 401 Missing, invalid, revoked or expired API key.
- 403 The key is valid but this call is not allowed: the key lacks the scope the call needs (insufficient_scope), the address is not allowed for the key (ip_not_allowed), the number or plan does not allow it, a recipient opted out or is not opted in, or a problem with the WhatsApp account.
- 404 The number, template, message, broadcast, webhook, delivery, opt-in, logged request, booking or Flow was not found.
- 429 A monthly plan limit, the number's own monthly cap, the key's daily cap, a WhatsApp rate limit, the API rate limit (rate_limited), or the webhook test limit (too_many_tests) was reached. Retry-After and error.retry_after_seconds say how long to wait.
- 500 Unexpected error on app2email's side.