The team: who works in the shared inbox
https://api.app2email.com/v1/{number}/submit/members Scope: submissions:manage. The owner, the dashboard's members and the people invited to just the inbox, each with their role, what they may do now (abilities), which forms they see and how many open submissions they hold. A member's id is what assignee takes in PATCH /submit/submissions/{id} and what member:<id> means in an assign action.
Path
-
Your app2email WhatsApp number - the number the message is sent FROM. Full number with country code, digits only.
e.g.4976659348270
Responses
Fields
- success boolean
- request_id string
- members object[]
17 item fields
- name stringe.g.
Sam - role string
owner: The account owner. Every ability. Cannot be changed or removed.admin: Every ability.manager: note, reply, edit, stage, assign, files, export, delete, run.agent: note, reply, edit, stage, files, run.viewer: Sees submissions, changes nothing.owneradminmanageragentviewer -
What the member may do now: the role's set with their own changes.
note: Write internal notes.reply: Reply to the submitter.edit: Edit answers and internal fields.stage: Change the stage.assign: Assign to anyone (an agent may always take a submission themselves).files: Add and remove files.export: Export.delete: Delete and restore.run: Run manual automations.forms: Manage forms and lists.automations: Manage automations and connections.team: Manage the team. - forms string[]
Only these forms (keys). [] = every form.
-
Sees only what is assigned to them.
-
With own_only: also sees unassigned submissions, to pick them up.
-
Numbers, e-mail addresses and answers of type phone or email are masked for this member.
- notify object
- id integere.g.
12 - email stringe.g.
sam@example.com -
Only the member's own changes to the role's set.
- status string
invitedactiveremoved - invite_expired boolean
true: the invitation was not accepted in time; invite the address again.
- invited string (date-time)
- accepted string (date-time) | null
- last_seen string (date-time) | null
- open_count integer
Open submissions assigned to them.
- count 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.
- 503 app2email's connection to the WhatsApp account needs attention, or the request log is not available right now.