Link a conversation to a record
curl --request POST \
--url https://{organization}.rescueconsole.com/api/communications/threads/{id}/links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity_type": "adoption_application",
"entity_id": "b8e7d6c5-4a3b-4c2d-8e1f-0a9b8c7d6e5f"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity_type: 'adoption_application',
entity_id: 'b8e7d6c5-4a3b-4c2d-8e1f-0a9b8c7d6e5f'
})
};
fetch('https://{organization}.rescueconsole.com/api/communications/threads/{id}/links', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/communications/threads/{id}/links"
payload = {
"entity_type": "adoption_application",
"entity_id": "b8e7d6c5-4a3b-4c2d-8e1f-0a9b8c7d6e5f"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"entity_type": "person",
"entity_id": "<string>",
"source": "<string>",
"is_confirmed": true,
"confirmed_at": "<string>",
"confirmed_by_person_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Conversations
Link a conversation to a record
Says what a conversation is about. The link is confirmed at once, so the conversation shows on that record; a suggested link to the same record becomes confirmed. A key sees the inboxes that the person who made the key may read, as that person’s access stands at the moment of the request; a conversation in any other inbox answers 404, the same as one that does not exist. Needs write on Communications.
POST
/
api
/
communications
/
threads
/
{id}
/
links
Link a conversation to a record
curl --request POST \
--url https://{organization}.rescueconsole.com/api/communications/threads/{id}/links \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"entity_type": "adoption_application",
"entity_id": "b8e7d6c5-4a3b-4c2d-8e1f-0a9b8c7d6e5f"
}
'const options = {
method: 'POST',
headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
body: JSON.stringify({
entity_type: 'adoption_application',
entity_id: 'b8e7d6c5-4a3b-4c2d-8e1f-0a9b8c7d6e5f'
})
};
fetch('https://{organization}.rescueconsole.com/api/communications/threads/{id}/links', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));import requests
url = "https://{organization}.rescueconsole.com/api/communications/threads/{id}/links"
payload = {
"entity_type": "adoption_application",
"entity_id": "b8e7d6c5-4a3b-4c2d-8e1f-0a9b8c7d6e5f"
}
headers = {
"Authorization": "Bearer <token>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text){
"id": "<string>",
"entity_type": "person",
"entity_id": "<string>",
"source": "<string>",
"is_confirmed": true,
"confirmed_at": "<string>",
"confirmed_by_person_id": "<string>",
"created_at": "2023-11-07T05:31:56Z"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}{
"error": "house_trained must be 1, 0 or null (not assessed)"
}Authorizations
An API key from Settings, API keys. It starts with rc_live_.
Path Parameters
The conversation's ID.
Body
application/json
Response
The link.
The kind of record a conversation can be about.
Available options:
person, organization, animal, location_unit, donation, campaign, shift, volunteer_event, shift_signup, adoption_application, org_event, form_submission How the link was made: manual (a person, or a key, linked it), sender_match (the sender's address matched exactly one person on file), or address_token and reply (carried over from the conversation a message answered).
Whether somebody has vouched for it. Only a confirmed link puts the conversation on the record.