Generate Form Link — 99 Digital API

Generate a link for an existing conversation or for a contact on a new conversation screen.

Settings:

URL	Method
`https://online.99digital.co.il/api/v1/accounts/{account_id}/forms/{form_id}/links`	JSON via POST

Authorization:

Header Parameter	Description
`api_access_token`	User API key; access depends on the user's permissions.
`Content-Type`	`application/json`

Path Parameters:

Parameter	Description	Required
`account_id`	Account identifier.	Yes
`form_id`	Form identifier in the path.	Yes

Request Body:

For an existing conversation, conversation_id is the conversation display ID:

{"conversation_id": 42}

For a contact who may not exist yet:

{"inbox_id": 7, "contact": {"email": "a@b.com", "name": "Dana"}}

Parameter	Description
`conversation_id`	Conversation display ID.
`inbox_id`	Inbox identifier.
`contact.email`	Contact email address.
`contact.name`	Contact name.

Request Examples:

curl -s -X POST -H "api_access_token: $TOKEN" -H "Content-Type: application/json" \
  "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/forms/$FORM/links" \
  -d '{"conversation_id": 1}'

curl -s -X POST -H "api_access_token: $TOKEN" -H "Content-Type: application/json" \
  "$BASE_URL/api/v1/accounts/$ACCOUNT_ID/forms/$FORM/links" \
  -d '{"inbox_id": 7, "contact": {"email": "a@b.com", "name": "Dana"}}'

Response:

{"form_link": "https://forms.example.com/forms/1/answer?t=<opaque-token>"}

Response-Explain:

Parameter	Description
`form_link`	Generated URL for opening the form.