Invite a contact to confirm a notification channel
POST/api/v1/workspaces/:id/contacts/:contactId/verifications/:channel
Requires a Cloud session and an admin or workspace_manager membership in this workspace. Email sends a confirmation invitation; WhatsApp returns a share link for the recipient to confirm from their own account. An opted-out destination remains opted out and receives no invitation from this operation.
Request
Responses
- 200
- 201
- 202
- 400
- 401
- 403
- 404
- 409
- 429
- 500
- 502
- 503
Destination opted out; email includes a recipient-initiated resubscribe URL
WhatsApp invitation pending; share_url must be shared with the recipient
Email confirmation invitation sent
Bad request
Unauthorized
Forbidden
Not found
Prior invitation dispatch is sending or uncertain (VERIFICATION_DISPATCH_UNCONFIRMED)
Invitation cooldown or rate limit; JSON may include retryAfter in seconds
Response Headers
When present, delay in seconds before retrying.
Internal server error
Email delivery failed or is uncertain (VERIFICATION_EMAIL_FAILED or VERIFICATION_EMAIL_UNCERTAIN)
Verification public URL, secret or schema is unavailable (RECIPIENT_VERIFICATION_UNAVAILABLE)