Criar invite

post/video-agreement/api/v1/account/invite

Request

Base URL
https://apigw.nuvidio.com
URL
https://apigw.nuvidio.com/video-agreement/api/v1/account/invite
Auth
OAuth 2

Request body

availableAtstring

Data de quando o invite estará disponível para utilização. Se não informado, a data de criação do invite será usado. Exemplo: 2025-03-29T17:21:00.000

expiresAtstring required

Data de expiração do invite.

timezonestring

Se não informado, o default será America/Sao_Paulo.

Response

201

availableAtstring

expiresAtstring

inviteIdstring

inviteUrlstring

expiredInviteUrlstring

invalidDataUrlstring

termsUrlstring

helpUrlstring

successUrlstring

timezonestring

customerJourneyTypestring

voiceGenderstring

Example response

{
  "availableAt": "2025-06-30T12:25:37.018-03:00",
  "expiresAt": "2025-06-30T19:00:48-03:00",
  "inviteId": "609faaca-dd93-413c-91d5-3b18fbf06713",
  "inviteUrl": "https://nuvidio.me/url",
  "expiredInviteUrl": "http://suaurlinformada.com",
  "invalidDataUrl": "http://suaurlinformada.com",
  "termsUrl": "http://suaurlinformada.com",
  "helpUrl": "http://suaurlinformada.com",
  "successUrl": "http://suaurlinformada.com",
  "timezone": "America/Sao_Paulo",
  "customerJourneyType": "self_declaration",
  "voiceGender": "not_applicable"
}

Changes

No recorded changes to this operation across all 1 revision of this API.