cobra CRM Cloud - API Docs
StartWebsitecobra Knowledge Portal
StartWebsitecobra Knowledge Portal
  • Welcome to our Developer Portal
  • Hybrid REST / GraphQL API
  • GraphQL API Endpoints
  • Versioning
  • Translated Responses
  • Tenant Context
  • Authentication
  • Pagination, Sorting, Filtering in GraphQL
  • Date/Time Format And Time Zones
  • Usage Policy
  • Access
    • Get a user by id
      GET
    • Update an existing user
      PUT
    • Delete a user
      DELETE
    • Create a new user
      POST
    • Deactivate an existing user
      POST
    • Activate an existing user
      POST
    • Reset the password for an existing user
      POST
    • Delete multiple users by id
      DELETE
    • Get available roles for a tenant
      GET
  • Auth
    • Get the OAuth2 configuration URL and the client ID.
      GET
    • Logs in to cobra with the login data and returns a bearer token if successful.
      POST
    • This is an implementation of the Introspect endpoint as defined in RFC 7662
      POST
  • cobra CRM
    • People360
      • Business Cards
        • Update an existing address in a business card of a person
          PUT
        • Delete an address from a specific business card of a person by its address ID
          DELETE
        • Create a new address in a person's existing business card
          POST
        • Update an existing business card of a specific person by the business card ID
          PUT
        • Retrieve the details of an existing business card from a specific person by the people ID and the business card ID
          GET
        • Delete a business card form a specific person by the business card ID
          DELETE
        • Retrieve the details of all existing business cards from a specific person by the people ID
          GET
        • Create a new business card for an existing person
          POST
        • Retrieve the details of an existing business card from a specific person only by the business card ID
          GET
        • Delete multiple business cards from a person by their IDs
          DELETE
        • Retrieve an existing person's business card as a vCard (.vcf)
          GET
      • Relations
        • Retrieve all relations of a given specific person by relation category
          GET
        • Relate two people with each other
          POST
        • Update a specific relation of a person
          PUT
        • Remove a relation between two people
          DELETE
        • Creates one or more existing relations to multiple people
          POST
        • Update one or more existing relations of a person
          PUT
        • Remove multiple relations of one or more people
          POST
      • Settings
        • Update the settings for People360 such as postal address validation etc
          PUT
      • Management
        • Create one or more new entries for people properties
          POST
        • Delete multiple entries for people properties from a list by their IDs
          DELETE
        • Delete an entry for people property from a list by its ID
          DELETE
        • Create one or more personality tags
          POST
        • Delete multiple personality tags from the list by their IDs
          DELETE
        • Delete a personality tag from the list by its ID
          DELETE
        • Create one or more new orga tags
          POST
        • Delete multiple orga tags from the list by their IDs
          DELETE
        • Delete an orga tag from the list by its ID
          DELETE
        • Create one or more new address types
          POST
        • Delete multiple address types from the list by their IDs
          DELETE
        • Delete an address type from the list by its ID
          DELETE
        • Create one or more life cycles
          POST
        • Delete multiple life cycles from the list by their IDs
          DELETE
        • Delete a life cycle from the list by its ID
          DELETE
        • Create one or more new manager roles that can be assumed by responsible people
          POST
        • Delete multiple manager roles from the list by their IDs
          DELETE
        • Delete a manager role from the list by its ID
          DELETE
        • Create one or more new address types
          POST
        • Delete multiple address types from the list by their IDs
          DELETE
        • Delete an address type from the list by its ID
          DELETE
      • Batch
        • Start a new process to validate addresses
          POST
        • Cancel an ongoing process that validates addresses
          POST
        • A data set with information about the process
          GET
      • PeopleMerge
        • If 2 people have been merged, this end point must be called at the end.
          POST
      • Retrieve people filtered by email or employee status or both
        GET
      • Retrieve a list of people
        GET
      • Create a new person
        POST
      • Retrieve the details of an existing person by its ID
        GET
      • Update an existing person by its ID
        PUT
      • Delete a person by its ID
        DELETE
      • Retrieve a quicklook of an existing person by its ID
        GET
      • Update one or more existing people
        PUT
      • Create one or more people
        POST
      • Delete multiple people by their IDs
        DELETE
      • Update the note on a person by its ID
        PUT
      • Update the list of orga tags on a person by its ID (the list will be overwrite)
        PUT
      • Update the list of personality tags on a person by its ID (the list will be overwrite)
        PUT
      • Update the lifecycle on a person by its ID
        PUT
      • Retrieve all type of profile images for a person by its ID
        GET
      • Upload a replacement profile image for a person by its ID
        POST
      • Delete the profile image of a person by its ID
        DELETE
    • Touchpoints
      • Documents
        • Upload a file to an existing touchpoint
          POST
        • Delete a file from a touchpoint by its ID
          DELETE
      • Settings
        • Configure which of the predefined touchpoint types and channels should be activated for use
          PUT
      • Management
        • Create one or more new tags
          POST
        • Delete multiple tags from the list by their IDs
          DELETE
        • Delete a tag from the list by its ID
          DELETE
      • Ai
        • Use AI to generate an email text based on the last touchpoints
          POST
        • Uses AI to generate a recommendation of the next steps based on the last touchpoints
          POST
      • Retrieve the details of an existing touchpoint by its ID
        GET
      • Create a new touchpoint
        POST
      • Update an existing touchpoint by its ID
        PUT
      • Delete a touchpoint by its ID
        DELETE
      • Delete multiple touchpoints by their IDs
        DELETE
      • Perform an input validation without changing the data set or creating a touchpoint in the database (calculated fields are returned)
        POST
      • Add one or more tags to selected touchpoints
        POST
      • Remove one or more tags from selected touchpoints by their IDs
        POST
      • Delete a person involved from the touchpoint by its ID
        DELETE
      • Update the priority for multiple touchpoints by their IDs
        PUT
      • Update the priority for a touchpoint by its ID
        PUT
      • Add the current mood to a touchpoint by its ID
        PUT
      • Move touchpoints from one person to another
        POST
    • Companies
      • Relations
        • Relate two companies with each other
          POST
        • Update a specific relation of a company
          PUT
        • Remove a relation between two companies
          DELETE
        • Update one or more existing relations of a company
          PUT
        • Remove multiple relations of one or more companies
          POST
        • Change the direction of the relation between two companies
          POST
      • Documents
        • Upload a file to an existing company
          POST
        • Delete a file from a company by its ID
          DELETE
      • Settings
        • Update the settings for Companies such as postal address validation etc.
          PUT
      • Management
        • Create one or more new tags
          POST
        • Delete multiple tags from the list by their IDs
          DELETE
        • Delete a tag from the list by its ID
          DELETE
        • Create one or more entries for number of employees
          POST
        • Delete multiple entries for number of employees from the list by their IDs
          DELETE
        • Delete an entry for number of employees from the list by its IDs
          DELETE
        • Create one or more entries for number of customers
          POST
        • Delete multiple entries for number of customers from the list by their IDs
          DELETE
        • Delete an entry for number of customers from the list by its IDs
          DELETE
        • Create one or more legal forms
          POST
        • Delete multiple legal forms from the list by their IDs
          DELETE
        • Delete a legal form from the list by its IDs
          DELETE
        • Create one or more reference number types
          POST
        • Delete multiple reference number types from the list by their IDs
          DELETE
        • Delete a reference number type from the list by its ID
          DELETE
        • Create one or more industry sectors
          POST
        • Delete multiple industry sectors from the list by their IDs
          DELETE
        • Delete an industry sector from the list by its ID
          DELETE
        • Create one or more relation types
          POST
        • Delete multiple relation types from the list by their IDs
          DELETE
        • Updates a relation Type
          PUT
        • Delete a relation type from the list by its ID
          DELETE
        • Create one or more life cycles
          POST
        • Delete multiple life cycles from the list by their IDs
          DELETE
        • Delete a life cycle from the list by its ID
          DELETE
      • Batch
        • A data set with information about the process
          GET
        • Cancel an ongoing process that validates addresses
          POST
        • Start a new process to validate addresses
          POST
      • Bank Accounts
        • Upload a file for the direct debit mandate to a company bank account
          POST
        • Delete a file for the direct debit authorization from a company bank account
          DELETE
      • Logos
        • Upload a replacement logo for a company by its ID
          POST
        • Delete the logo from a company by its ID
          DELETE
        • Upload a logo for a company by its ID using the clearbit api and delete the old logo
          POST
      • Create a new address for an exisiting company
        POST
      • Update an existing address of a specific company by its ID This endpoint should be only used by the frontend
        PUT
      • Delete an address from a specific company by its ID
        DELETE
      • Retrieve the details of an existing company by its ID
        GET
      • Update an existing company by its ID
        PUT
      • Delete a company by its ID
        DELETE
      • Retrieve the details of a company by its domain
        GET
      • Create a new company
        POST
      • Update the note on a company by its ID
        PUT
      • Update the list of tags on a company by its ID (the list will be overwrite)
        PUT
      • Update the lifecycle on a company by its ID
        PUT
      • Delete multiple companies by their IDs
        DELETE
      • Add one or more tags to selected companies
        POST
      • Remove one or more tags from selected companies by their IDs
        POST
      • Add a new phone number to an exisitng company
        POST
      • Update an existing phone number of a specific company by its ID
        PUT
      • Delete a phone number form a specific company by its ID
        DELETE
      • Perform an input validation without changing the data set or creating a company in the database (calculated fields are returned)
        POST
      • Add a new e-mail address to an existing company
        POST
      • Update an existing e-mail address of a specific company by its ID
        PUT
      • Delete an e-mail address form a specific company by its ID
        DELETE
  • cobra Event
    • Settings
      • Booking form field sets
        • Gets a field set for booking forms by its ID
          GET
        • Updates an existing field set for booking forms
          PUT
        • Deletes an existing field set for booking forms
          DELETE
        • Creates a new field set for booking forms
          POST
        • Validates a field set for booking forms
          POST
        • Replaces all references to existing booking form field set by another set.
          POST
      • Cancellation conditions
        • Gets a cancellation condition by its ID
          GET
        • Updates an existing cancellation condition
          PUT
        • Deletes an existing cancellation condition
          DELETE
        • Creates a new cancellation condition
          POST
        • Validates a cancellation condition
          POST
        • Replaces all references to existing cancellation condition by another condition.
          POST
      • Contact person templates (copy list)
        • Gets a contact person template by its ID
          GET
        • Updates an existing contact person template
          PUT
        • Deletes an existing contact person template
          DELETE
        • Creates a new contact person template
          POST
        • Deletes a list of contact person templates
          DELETE
        • Validates a contact person template
          POST
      • Contributor roles (tenant list)
        • Gets a contributor role by its ID
          GET
        • Updates an existing contributor role
          PUT
        • Deletes an existing contributor role
          DELETE
        • Creates a new contributor role
          POST
        • Deletes a list of contributor roles
          DELETE
        • Validates a contributor role
          POST
        • Replaces all references to existing contributor role by another contributor role.
          POST
      • Event categories (tenant list)
        • Gets an event category by its ID
          GET
        • Updates an existing event category
          PUT
        • Deletes an existing event category
          DELETE
        • Creates a new event category
          POST
        • Deletes a list of event categories
          DELETE
        • Validates an event category
          POST
        • Replaces all references to existing event category by another event category.
          POST
      • Online meeting platforms (vendor list)
        • Gets a online meeting platform by its ID
          GET
      • Orga tags (adhoc list)
        • Gets an orga tag by its ID
          GET
        • Updates an existing orga tag
          PUT
        • Deletes an existing orga tag
          DELETE
        • Creates a new orga tag
          POST
        • Deletes a list of orga tags
          DELETE
        • Validates an orga tag
          POST
        • Replaces all references to existing orga tag by another orga tag.
          POST
      • Tax rates (vendor list)
        • Gets a tax rate by its ID
          GET
      • Portal tags (tenant list)
        • Gets a portal tag by its ID
          GET
        • Updates an existing portal tag
          PUT
        • Deletes an existing portal tag
          DELETE
        • Creates a new portal tag
          POST
        • Deletes a list of portal tags
          DELETE
        • Validates a portal tag
          POST
        • Replaces all references to existing portal tag by another portal tag.
          POST
      • Gets the event settings for the current tenant
        GET
      • Updates the event settings for the current tenant
        PUT
      • Validates the event settings
        POST
    • Event files
      • Uploads the provided file for the event
        POST
      • Deletes the file with the specified url of an event
        DELETE
      • Deletes all files of an event
        DELETE
    • Event images
      • Uploads an image of a certain type for the event
        POST
      • Deletes the image with the specified url of an event
        DELETE
      • Deletes all images of an event
        DELETE
      • Updates the alternative text of an image
        POST
    • Contact person template images
      • Uploads an image for the contact person template.
        POST
      • Deletes the contact person template image.
        DELETE
      • Deletes a list of contact person template images.
        DELETE
    • Bookings
      • Creates a new booking (public)
        POST
      • Gets a booking by its ID
        GET
      • Gets the confirmation infos for a successful booking (public)
        GET
      • Deletes an existing booking
        DELETE
      • Deletes a list of bookings
        DELETE
      • Calculates the current cancellation rules that apply when cancelling a booking including all tickets
        POST
      • Cancels a booking and all belonging tickets
        POST
      • Cancels a booking and all belonging tickets
        POST
      • Calculates the current cancellation rules that apply when cancelling a booking including all tickets
        GET
      • Sets the booker information for a booking
        POST
      • Sends an invoice mail to the booker
        POST
      • Sets the invoice number of an external booking
        POST
      • Change the status of a payment
        POST
      • Collects the booking history statistics for an event
        POST
      • Collects the booking history actions for an event
        POST
    • Invitations
      • Gets details of an invitation (public)
        GET
      • Gets an invitation by its ID
        GET
      • Gets details of an invitation (public)
        GET
      • Deletes an existing invitation
        DELETE
      • Reject an Invitation. If a ticket was already bought using this invitation, the ticket is cancelled.
        POST
      • Deletes a list of invitations
        DELETE
      • Creates a new invitation for an event
        POST
      • Validates an invitation
        POST
      • Send an invitation e-mail to a list of persons to invite
        POST
      • Send an filtered invitation e-mail to a list of persons to invite
        POST
      • Send an invitation free e-mail to a list of persons to invite
        POST
      • Send an filtered invitation free e-mail to a list of persons to invite
        POST
      • Sets information data for the invited person
        POST
      • Imports invitations from a file
        POST
      • Generates a preview for a file import
        POST
      • Exports invitations for an event
        POST
      • Change the status of a list of participants
        POST
    • Event tickets
      • Gets an event ticket by its ID
        GET
      • Add custom integration data to an event ticket
        POST
      • Get an event ticket summary
        GET
      • Change the status of a list of participants
        POST
      • Resend event tickets to a list of participants
        POST
      • Send free mails to a list of participants
        POST
      • Send free mails to filtered participants
        POST
      • Validates an event ticket and checks it in
        POST
      • Sets participant information data
        POST
      • Exports event tickets
        POST
    • Website images
      • Uploads an image of a certain type for the website
        POST
      • Deletes the image with the specified url of a website
        DELETE
      • Deletes all images of a website
        DELETE
      • Updates the alternative text of an image
        POST
    • Websites
      • Gets a website by its ID
        GET
      • Gets an event by its ID (public)
        GET
      • Updates an existing website
        PUT
      • Gets the field set for booking forms that is used by an event (public)
        GET
      • Deletes an existing website
        DELETE
      • Gets a portal config by its url (public)
        GET
      • Creates a new website
        POST
      • Deletes a list of websites
        DELETE
      • Validates a website
        POST
      • Validates a website
        POST
      • Replaces all references to existing event portal by another event portal: all events using the original portal will migrate to the replacement portal.
        POST
      • Enables or disables the publication of a website
        POST
      • Validates the publication of a website
        POST
    • Gets an event by its ID
      GET
    • Updates an existing event
      PUT
    • Deletes an existing event
      DELETE
    • Creates a new event
      POST
    • Deletes a list of events
      DELETE
    • Validates an event
      POST
    • Get event as iCal format
      GET
    • Duplicates an event
      POST
    • Updates the note of an event
      PUT
    • Updates the publication of an event
      PUT
    • Validates the publication of an event
      POST
  • Tickets
    • Get a ticket by id
      GET
    • Update an existing ticket
      PUT
    • Delete a ticket
      DELETE
    • Create a new ticket
      POST
    • Change ticket state (New, In Progress, Done)
      POST
  • Integrations
    • Webhooks
      • Get a list of all webhook subscriptions
        GET
      • Create a new webhook subscription
        POST
      • Get a webhook subscription by ID
        GET
      • Delete a webhook subscription
        DELETE
      • Change a webhook subscription
        PUT
      • Lists all Webhook events which can be subscribed
        GET
    • EAP
      • Connectors
        • Get all available folders of a mailbox
          GET
        • Get all available categories of a mailbox
          GET
        • Get all available user with short and display name of cobra CRM
          GET
      • RuleActions
        • Get all actions of a rule
          GET
        • Create a new action for a rule
          POST
        • Delete an action by id
          DELETE
        • Delete all actions for the rule
          DELETE
      • RuleFilters
        • Get all filters of a rule which are used to filter emails before applying actions
          GET
        • Create a new filter for a rule
          POST
        • Delete all filters of a rule
          DELETE
      • Rules
        • Get all rules for the current user
          GET
        • Create a new rule for the current user
          POST
        • Get a rule by id
          GET
        • Modify an existing rule
          PATCH
        • Delete a rule by id
          DELETE
      • Runs
        • Run a specific rule for automated email processing
          POST
  • TenantInfo
    • Returns general information such as the TenantId and contact details of the client currently logged in.
      GET
    • This can be used to read out the client's currently set tariff, including all available modules and their functions contained in the tariff.
      GET
    • Returns general information about the tenants subscription.
      GET

Welcome to our Developer Portal

Welcome, Developers!
Welcome to the cobra CRM API documentation portal. We're thrilled to have you here as you embark on integrating with cobra CRM. Whether you're enhancing functionality, building custom solutions, or exploring new possibilities, our API is here to empower your projects.
Explore our comprehensive API documentation, rich with endpoints, guides, and examples to streamline your integration process. If you have any questions, our dedicated support team is ready to assist you every step of the way.
Let's build together and unlock the full potential of cobra CRM. Happy coding!
Your cobra product team
Modified at 2024-07-23 14:27:10
Next
Hybrid REST / GraphQL API
Built with