Arguments
- gatheringId is the required integer ID of the gathering.
- id is the required integer ID of the attendee.
- attendee is AttendeeParams, the set of fields used to update an attendee.
AttendeeParams
AttendeeParams is a structure containing fields that can be provided to update an Attendee.
| Field | Type | Description | |---|---|---| | firstName | String | Attendee first name. Displayed if present. | | lastName | String | Attendee last name. Displayed if present. | | prefix_name | String | Attendee honorific (Mr., Ms., Dr.). Displayed if present. | | login_email | String | Email used to login. Not displayed. | | organization | String | Attendee organization or company. Displayed if present. | | job_title | String | Attendee organization or company. Displayed if present. | | email | String | Attendee email. Displayed if present. Not related to the login email. | | participantTypes | Array of Strings | To add one or more participant types, provide an array of strings containing those participant types. Participant Types are used to control access to content. | | telephone | String | Attendee preferred telephone number. Displayed if present. | | website | String | Attendee URL. Displayed if present. | | twitterHandle | String | Attendee Twitter handle. @ is optional. Displayed if present. | | facebookUsername | String | Attendee Facebook username. Not a URL. Displayed if present. | | linkedInUrl | String | Attendee LinkedIn URL. Displayed if present. | | street | String | Attendee Street (e.g., 3722 Maplehurst Drive). Displayed if present. | | street2 | String | Attendee Street - supplemental (e.g., Suite 181). Displayed if present. | | city | String | Attendee last name. Displayed if present. | | state | String | Attendee's state or province. Displayed if present. | | postalCode | String | Attendee's Postal or ZIP code. Displayed if present. | | country | String | Attendee's country. Displayed if present. | | badgeCode | String | The code on an Attendee badge that will be scanned to retrieve sales lead information. Not displayed. | | leadEmail | String | The email address that will be supplied to a person scanning an attendee badge to retrieve sales lead information. Not displayed. | | leadAddress | String | The complete geographic address that will be supplied to a person scanning an attendee badge to retrieve sales lead information. Not displayed. | | leadPhone | String | The telephone number that will be supplied to a person scanning an attendee badge to retrieve sales lead information. Not displayed. | | biographyHtml | String | Attendee biography in HTML format. Distinct from BiographyText. Displayed if present. Not editable by attendee. | | biographyText | String | Attendee biography in text format. Distinct from BiographyHtml. Displayed if present. Editable by attendee. | | hidden | Boolean | If this boolean is set to true, this attendee will not be visible in the mobile app and cannot participate socially. | | externalId | String | The unique ID of the attendee from its source (i.e., the attendee id in your system). Not displayed. | | externalSource | String | External data source of the attendee. If you have created this attendee in the Touchpoint system, Touchpoint will define the external_source. Not displayed. | | photoUrl | String | If the photo resides at a publicly available URL, you may provide that URL here (.jpg or .png format). The image at that URL will be copied into the Touchpoint system. | | photo | DataUpload | Choose multipart file (preferred) and Base64. To provide the photo file as a file, use multipart/form-data. | | photoUrl | (Repeated under photo) | See above; same meaning as above. | | photo (DataUpload) | See above | See above; details for multipart or Base64 uploads. |
Providing a Photo/Avatar
- You may supply an attendee photo in several ways.
- Using the photoUrl attribute, you may supply a URL. The image at that URL will be copied into the Touchpoint system.
- Using the photo attribute you may supply either a Base64 encoded string or an image file using the multipart/form-data content type. An image file is preferred to the Base64 string as it will be smaller.
- photoUrl is a String. If the photo resides at a publicly available URL, you may provide that URL here (.jpg or .png format). The image at that URL will be copied into the Touchpoint system.
- photo (DataUpload) supports either a multipart file or a Base64-encoded string.
- To provide the photo as a file, you should use the multipart/form-data content type. For example:
curl -X POST https://api.certaintouchpoint.com/graphql -H 'Content-Type: application/graphql' -H 'Authorization: Bearer 123abcveryLongAuthorizationToken456def' -F query='mutation { createAttendee(attendee: { firstName: "David Foster", lastName: "Wallace", photo: "photo_argument"}, gatheringId: 232) { firstName lastName id } }' -F photo_argument=@photo.jpg
- Notice that the value of the photo attribute is the name of the argument used to refer to the photo file.
- To provide the photo file as a Base64 encoded string, prefix the photo string with the information: data:<mime type>;base64,<encoded data>
- For example:
curl -X POST https://api.certaintouchpoint.com/graphql -H 'Content-Type: application/graphql' -H 'Authorization: Bearer 123abcveryLongAuthorizationToken456def' -d '{ mutation { createAttendee(attendee: { firstName: "David Foster", lastName: "Wallace", photo: "data:image/jpg;base64,alongbase64encodedstring"}, gatheringId: 232) { firstName lastName id } }'
- Retrieving Relationships
- assignedAgendaSessions (String) Agenda Sessions that have been preregistered for the Attendee
- bookmarksAgendaSessions (String) Agenda Sessions that have been selected by the Attendee
- checkedInAgendaSessions (String) Agenda Sessions that the Attendee has checked into
- Creating Relationships
- To update assigned agenda sessions assignedAgendaSessionIds (Array of Ids) The unique ID of the attendee from it’s source (i.e., the attendee id in your system). Not displayed.
GraphQL Mutation
mutation {
updateAttendee(attendee: {firstName: "David Foster", lastName: "Wallace" }, gatheringId: 232, id: 71111) {
firstName
lastName
id
}
}
CURL Request
curl -X POST https://api.certaintouchpoint.com/graphql -H 'Content-Type: application/graphql' -H 'Authorization: Bearer 123abcveryLongAuthorizationToken456def' -d '{ mutation { updateAttendee(attendee: { firstName: "David Foster", lastName: "Wallace"}, gatheringId: 232, id: 71111) { firstName lastName id } }'
GraphQL Response
{"data":
{ "updateAttendee":
{ "lastName":"Wallace",
"id":"71111",
"firstName":"David Foster"
}
}
}
AttendeeParams (continued)
- firstName (String) Attendee first name. Displayed if present.
- lastName (String) Attendee last name. Displayed if present.
- prefix_name (String) Attendee honorific (Mr., Ms., Dr.). Displayed if present.
- login_email (String) Email used to login. Not displayed.
- organization (String) Attendee organization or company. Displayed if present.
- job_title (String) Attendee organization or company. Displayed if present.
- email (String) Attendee email. Displayed if present. Not related to the login email.
- participantTypes (Array of Strings) To add one or more participant types, provide an array of strings containing those participant types. Participant Types are used to control access to content.
- telephone (String) Attendee preferred telephone number. Displayed if present.
- website (String) Attendee URL. Displayed if present.
- twitterHandle (String) Attendee Twitter handle. @ is optional. Displayed if present.
- facebookUsername (String) Attendee Facebook username. Not a URL. Displayed if present.
- linkedInUrl (String) Attendee LinkedIn URL. Displayed if present.
- street (String) Attendee Street (3722 Maplehurst Drive). Displayed if present.
- street2 (String) Attendee Street - supplemental (e.g., Suite 181). Displayed if present.
- city (String) Attendee last name. Displayed if present.
- state (String) Attendee's state or province. Displayed if present.
- postalCode (String) Attendee's Postal or ZIP code. Displayed if present.
- country (String) Attendee's country. Displayed if present.
- badgeCode (String) The code on an Attendee badge that will be scanned to retrieve sales lead information. Not displayed.
- leadEmail (String) The email address that will be supplied to a person scanning an attendee badge to retrieve sales lead information. Not displayed.
- leadAddress (String) The complete geographic address that will be supplied to a person scanning an attendee badge to retrieve sales lead information. Not displayed.
- leadPhone (String) The telephone number that will be supplied to a person scanning an attendee badge to retrieve sales lead information. Not displayed.
- biographyHtml (String) Attendee biography in HTML format. Distinct from BiographyText. Displayed if present. Not editable by attendee.
- biographyText (String) Attendee biography in text format. Distinct from BiographyHtml. Displayed if present. Editable by attendee.
- hidden (Boolean) If this boolean is set to true, this attendee will not be visible in the mobile app and cannot participate socially.
- externalId (String) The unique ID of the attendee from its source (i.e., the attendee id in your system). Not displayed.
- externalSource (String) External data source of the attendee. If you have created this attendee in the Touchpoint system, Touchpoint will define the external_source. Not displayed.
- Providing a Photo/Avatar
- You may supply an attendee photo in several ways. Using the photoUrl attribute, you may supply a URL. Using the photo attribute you may supply either a Base64 encoded string or an image file using the multipart/form-data content type. An image file is preferred to the Base64 string as it will be smaller.
- photoUrl (String) If the photo resides at a publicly available URL, you may provide that URL here (.jpg or .png format). The image at that URL will be copied into the Touchpoint system.
- photo (DataUpload) Choose multipart file (preferred) and Base64:
- To provide the photo as a file, you should use the multipart/form-data content type. For example:
curl -X POST https://api.certaintouchpoint.com/graphql -H 'Content-Type: application/graphql' -H 'Authorization: Bearer 123abcveryLongAuthorizationToken456def' -F query='mutation { createAttendee(attendee: { firstName: "David Foster", lastName: "Wallace", photo: "photo_argument"}, gatheringId: 232) { firstName lastName id } }' -F photo_argument=@photo.jpg
- Notice that the value of the photo attribute is the name of the argument used to refer to the photo file.
- To provide the photo file as a Base64 encoded string, prefix the photo string with the information: data:<mime type>;base64,<encoded data>
- For example:
curl -X POST https://api.certaintouchpoint.com/graphql -H 'Content-Type: application/graphql' -H 'Authorization: Bearer 123abcveryLongAuthorizationToken456def' -d '{ mutation { createAttendee(attendee: { firstName: "David Foster", lastName: "Wallace", photo: "data:image/jpg;base64,alongbase64encodedstring"}, gatheringId: 232) { firstName lastName id } }'
- Retrieving Relationships
- assignedAgendaSessions (String) Agenda Sessions that have been preregistered for the Attendee
- bookmarksAgendaSessions (String) Agenda Sessions that have been selected by the Attendee
- checkedInAgendaSessions (String) Agenda Sessions that the Attendee has checked into
- Creating Relationships
- assignedAgendaSessionIds (Array of Ids) The unique ID of the attendee from its source (i.e., the attendee id in your system). Not displayed.
Related Articles
- Overview - Touchpoint API
- createAttendee
- Attendees Query
- Adding a Live Poll Results web view to a Powerpoint Presentation
- deleteAttendee